sekreti 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 108dc200e277cc9f254211e0d92c30783ab5f8a721da05865519c45f2a641022
+  data.tar.gz: 7ab731092115d74199651c9cd2abf3068852f457a52034cc18cd20157947c996
+SHA512:
+  metadata.gz: 90f91b9dccca63e2e3624eca0b9ed4db17af7564b87cf596fd50118e33b90ae90b016d455e0e7fc5f39f52d014a70d3ebb7fcb056505a4ed4078f6e4e8b2f454
+  data.tar.gz: 2ede38a4586530a9ac6d4e27241f7d52cbd3e2e17a872425dea65e0284f0fad6f982866daadb882e3ff1e1f7d0770d2dcf153609f53f588c1fddf538d4cffd59

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vendor/
+Gemfile.lock
+# rspec failure tracking
+.rspec_status
+test.rb

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gautierfrancois@outlook.com
+. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sekret.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 atille
+
+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/README.md

@@ -0,0 +1,87 @@
+# sekreti
+
+sekreti is an easy-to use yet minimal Gem to encrypt and decrypt file. It is based upon OpenSSL and intends to be as easy as possible on usage.
+\
+At the moment, sekreti only supports AES-128-CBC encryption protocol, but some other could be added in the future.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sekreti'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sekreti
+
+## Usage
+
+From a Ruby file, basic steps are :
+
+
+### Encrypt a file
+```ruby
+require "sekreti"
+
+# Encrypt a file 
+encrypt = sekreti::Crypt.new
+encrypt.file = "./decrypted_file.txt"
+encrypt.output_file = "./encrypted_output.txt"
+encrypt.salt = "aaaaaaaaaaaaaaaa" # a 16 bytes long encryption key
+
+# Validate that everything is ok 
+
+encrypt.file? # true
+encrypt.output_file? # true
+encrypt.salt? # true
+
+# Encrypt the file
+encrypt.status? # false
+encrypt.encrypt! # returns true
+encrypt.status? # true
+```
+
+### Decrypt a file
+```ruby
+require "sekreti"
+
+decrypt = sekreti::Crypt.new
+decrypt.file = "./encrypted_file.txt"
+decrypt.output_file = "./decrypted_output.txt"
+decrypt.salt = "aaaaaaaaaaaaaaaa" # a 16 bytes long decryption key
+
+# Validate that everything is ok
+
+decrypt.file? # true
+decrypt.output_file? # true
+decrypt.salt? # true
+
+# Decrypt the file
+decrypt.status? # false
+decrypt.decrypt! # returns true
+decrypt.status? # true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sekreti. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the sekreti project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sekreti/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,36 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "sekreti"
+require "securerandom"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+namespace :sekreti do
+  desc "Encrypt a file using sekreti gem"
+  task :encrypt do
+    sekreti = sekreti::Crypt.new
+    sekreti.file = ENV["sekreti_FILE"]
+    sekreti.output_file = ENV["sekreti_OUTPUT"]
+    unless ENV["sekreti_KEY"]
+      sekreti.salt = SecureRandom.hex(32)[0..15]
+    else
+      sekreti.salt = ENV["sekreti_KEY"]
+    end
+    
+    if sekreti.encrypt!
+      puts "File encrypted. Decryption key is #{sekreti.salt}"
+    end
+  end
+
+  desc "Decrypt a file using sekreti gem"
+  task :decrypt do
+    sekreti = sekreti::Crypt.new
+    sekreti.file = ENV["sekreti_FILE"]
+    sekreti.outpuf_file = ENV["sekreti_OUTPUT"]
+    sekreti.salt = ENV["sekreti_KEY"]
+    if sekreti.decrypt!
+      puts "File decrypted."
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sekreti"
+
+# 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/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/lib/sekreti/core.rb

@@ -0,0 +1,40 @@
+require "openssl"
+module Sekreti
+  # Main class performing operations.
+  class Core
+    # Encrypts a file with AES-128-CBC cipher, using
+    # a submitted 16 bytes string.
+    # @param options [Hash] submitted parameters
+    # @return boolean
+    def self.encrypt!(options)
+      cipher = OpenSSL::Cipher.new("AES-128-CBC")
+      cipher.encrypt
+      cipher.key = options[:salt]
+
+      outf = File.open(
+        options[:output_file], 
+        'wb'
+      )
+      
+      encrypted = cipher.update(File.read(options[:path])) + cipher.final
+      outf.write(encrypted)
+
+      return true
+    end
+
+    # Decrypts a file with a submitted key.
+    # @param options [Hash] submitted parameters
+    # @return boolean
+    def self.decrypt!(options)
+      decipher = OpenSSL::Cipher.new("AES-128-CBC")
+      decipher.decrypt
+      decipher.key =  options[:salt]
+  
+      f = File.open(options[:output_file], 'w')
+      decrypted = decipher.update(File.read(options[:path])) + decipher.final
+      f.write(decrypted)
+
+      return true
+    end
+  end
+end

data/lib/sekreti/crypt.rb

@@ -0,0 +1,127 @@
+require_relative "./core"
+
+module Sekreti
+  # Access helper to call the encryption and decryption
+  # actions.
+  class Crypt
+    def initialize(options={})
+      @options = options
+    end
+
+    # Returns entry file
+    # @return entry file
+    def file
+      @options[:path]
+    end
+
+    # Defines entry file
+    # @param path [String] relative or absolute path to 
+    #   entry file.
+    def file=(path)
+      @options[:path] = path
+    end
+
+    # Returns true if entry file is defined and
+    # exists. 
+    # @return boolean
+    def file?
+      unless @options.key?(:path)
+        return false
+      end
+
+      unless File.file? @options[:path]
+        return false
+      end
+
+      true
+    end
+
+    # Returns output file parameter
+    # @return output file parameter
+    def output_file
+      @options[:output_file]
+    end
+
+    # Defines the output file
+    # @param output_file [String] relative or absolute path
+    #   to output file.
+    def output_file=(output_file)
+      @options[:output_file] = output_file
+    end
+
+    # Returns true if the output file is defined and 
+    #  it doesn't exist yet.
+    # @return bool
+    def output_file?
+      unless @options.key?(:output_file)
+        return false
+      end
+
+      if File.file? @options[:output_file]
+        return false
+      end
+
+      true
+    end
+
+    # Returns the encryption salt
+    # @return encryption salt
+    def salt
+      @options[:salt]
+    end
+
+    # Set the encryption salt
+    # @param salt [String] 16 bytes string
+    # @return boolean
+    def salt=(salt)
+      unless salt.length == 16
+        raise StandardError, "Salt must be 16 bytes."
+      end
+
+      @options[:salt] = salt
+    end
+
+    # returns true if salt is defined.
+    # @return boolean
+    def salt?
+      unless @options.key?(:salt)
+        return false
+      end
+
+      true
+    end
+
+    # Encrypts a file with parameters set
+    # @see Core.encrypt!
+    def encrypt!
+      raise StandardError, "No entry file defined." unless file?
+      raise StandardError, "No output file defnined" unless output_file?
+      raise StandardError, "No salt defined" unless salt?
+
+      if Core.encrypt!(@options)
+        @options[:status] = true
+      else
+        @options[:status] = false
+      end
+    end
+
+    # Decrypts a file with parameters set
+    # @see Core.decrypt!
+    def decrypt!
+      raise StandardError, "No entry file defined." unless file?
+      raise StandardError, "No output file defnined" unless output_file?
+      raise StandardError, "No salt defined" unless salt?
+
+      if Core.decrypt!(@options)
+        @options[:status] = true
+      else
+        @options[:status] = false
+      end
+    end
+
+    # Returns the action status.
+    def status?
+      @options[:status]
+    end
+  end
+end

data/lib/sekreti/version.rb

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

data/lib/sekreti.rb

@@ -0,0 +1,6 @@
+require "sekreti/version"
+require "sekreti/crypt"
+
+module Sekreti
+  class Error < StandardError; end
+end

data/sekreti.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sekreti/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sekreti"
+  spec.version       = Sekreti::VERSION
+  spec.authors       = ["atille"]
+  spec.email         = ["gautierfrancois@outlook.com\n"]
+
+  spec.summary       = %q{Easy-to-use encryption/decryption library}
+  spec.description   = %q{Easy-to-use and configure encryption and decryption library based upon OpenSSL}
+  spec.homepage      = "https://github.com/atilleh/sekreti"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/atilleh/sekreti"
+  spec.metadata["changelog_uri"] = "https://github.com/atilleh/sekreti/tree/master/changelog.md"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: sekreti
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- atille
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: Easy-to-use and configure encryption and decryption library based upon
+  OpenSSL
+email:
+- 'gautierfrancois@outlook.com
+
+'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sekreti.rb
+- lib/sekreti/core.rb
+- lib/sekreti/crypt.rb
+- lib/sekreti/version.rb
+- sekreti.gemspec
+homepage: https://github.com/atilleh/sekreti
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/atilleh/sekreti
+  source_code_uri: https://github.com/atilleh/sekreti
+  changelog_uri: https://github.com/atilleh/sekreti/tree/master/changelog.md
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Easy-to-use encryption/decryption library
+test_files: []