sekreti 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 108dc200e277cc9f254211e0d92c30783ab5f8a721da05865519c45f2a641022
-  data.tar.gz: 7ab731092115d74199651c9cd2abf3068852f457a52034cc18cd20157947c996
+  metadata.gz: b1d51efb62be86810b62a97753d3be7a475c2bbe2e729eb84cb88638f6d56fb7
+  data.tar.gz: 8821f5364226ed49628cf4a7283c8e35d61be2a69fb471effddc4248762e1367
 SHA512:
-  metadata.gz: 90f91b9dccca63e2e3624eca0b9ed4db17af7564b87cf596fd50118e33b90ae90b016d455e0e7fc5f39f52d014a70d3ebb7fcb056505a4ed4078f6e4e8b2f454
-  data.tar.gz: 2ede38a4586530a9ac6d4e27241f7d52cbd3e2e17a872425dea65e0284f0fad6f982866daadb882e3ff1e1f7d0770d2dcf153609f53f588c1fddf538d4cffd59
+  metadata.gz: c0a5cbc6fc2b87101d66b251af285bd879dbc1d375858973b68cfc3c447437d49bcac9e50a8430dbb803cf9c523f485e391b33da4cd41d1bf3e2eab98be2308b
+  data.tar.gz: 5a10038e3e8d038414b93196937508fa12d019ac5307372484d401d1c4234c41d3c598cc17e977bed8565c0a21fbd47f44c6cd5e5ec7554e01efc590ce661e0e

data/Gemfile

@@ -2,3 +2,8 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sekret.gemspec
 gemspec
+
+group :development do
+    gem 'yard'
+    gem 'redcarpet'
+end

data/README.md

@@ -1,15 +1,17 @@
 # sekreti
 
+[![Gem Version](https://badge.fury.io/rb/sekreti.svg)](https://badge.fury.io/rb/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.
+Sekreti currently supports `AES-128-CBC` and `AES-256-CBC` protocol.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sekreti'
+gem 'sekreti', '1.0.0'
 ```
 
 And then execute:
@@ -29,22 +31,28 @@ From a Ruby file, basic steps are :
 ```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
+encrypt.protocol = "AES-256-CBC" # is aes-128-cbc by default
+
+# You must define an encryption key.
+# Is 16 bytes long for aes-128-cbc
+# Is 32 bytes long for aes-256-cbc
+encrypt.key = "a" * 32 # a 16 bytes long encryption key for aes-128-cbc
 
 # Validate that everything is ok 
 
 encrypt.file? # true
 encrypt.output_file? # true
-encrypt.salt? # true
+encrypt.key? # true
+
 
 # Encrypt the file
 encrypt.status? # false
 encrypt.encrypt! # returns true
 encrypt.status? # true
+encrypt.dump # Returns the whole state
 ```
 
 ### Decrypt a file
@@ -54,18 +62,21 @@ 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
+decrypt.key = "a" * 32
 
 # Validate that everything is ok
 
 decrypt.file? # true
 decrypt.output_file? # true
-decrypt.salt? # true
+decrypt.key? # true
 
 # Decrypt the file
 decrypt.status? # false
 decrypt.decrypt! # returns true
 decrypt.status? # true
+
+# Dump the whole state 
+decrypt.dump 
 ```
 
 ## Development
@@ -74,9 +85,14 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+The documentation can be generated with `Yard` :
+```bash
+bundle exec rake doc
+```
+
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/atilleh/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
 
@@ -84,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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).
+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/atilleh/sekreti/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -10,12 +10,12 @@ namespace :sekreti do
   desc "Encrypt a file using sekreti gem"
   task :encrypt do
     sekreti = sekreti::Crypt.new
-    sekreti.file = ENV["sekreti_FILE"]
+    sekreti.file = ENV["SEKRETI_FILE"]
     sekreti.output_file = ENV["sekreti_OUTPUT"]
-    unless ENV["sekreti_KEY"]
+    unless ENV["SEKRETI_KEY"]
       sekreti.salt = SecureRandom.hex(32)[0..15]
     else
-      sekreti.salt = ENV["sekreti_KEY"]
+      sekreti.salt = ENV["SEKRETI_KEY"]
     end
     
     if sekreti.encrypt!
@@ -26,11 +26,16 @@ namespace :sekreti do
   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"]
+    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
+
+desc "Generates documentation with Yard"
+task :doc do
+  sh "bundle exec yardoc"
 end

data/lib/sekreti.rb

@@ -3,4 +3,4 @@ require "sekreti/crypt"
 
 module Sekreti
   class Error < StandardError; end
-end
+end

data/lib/sekreti/core.rb

@@ -2,39 +2,49 @@ require "openssl"
 module Sekreti
   # Main class performing operations.
   class Core
+
+    protected
     # 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]
+      begin
+        cipher = OpenSSL::Cipher.new(options[:protocol])
+        cipher.encrypt
+        cipher.key = options[:key]
 
-      outf = File.open(
-        options[:output_file], 
-        'wb'
-      )
-      
-      encrypted = cipher.update(File.read(options[:path])) + cipher.final
-      outf.write(encrypted)
+        f = File.open(
+          options[:output_file], 
+          'wb'
+        )
+        
+        encrypted = cipher.update(File.read(options[:path])) + cipher.final
+        f.write(encrypted)
 
-      return true
+        return true
+      rescue
+        return false
+      end
     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)
+      begin
+        decipher = OpenSSL::Cipher.new(options[:protocol])
+        decipher.decrypt
+        decipher.key =  options[:key]
+    
+        f = File.open(options[:output_file], 'w')
+        decrypted = decipher.update(File.read(options[:path])) + decipher.final
+        f.write(decrypted)
 
-      return true
+        return true
+      rescue
+        return false
+      end
     end
   end
 end

data/lib/sekreti/crypt.rb

@@ -4,8 +4,31 @@ module Sekreti
   # Access helper to call the encryption and decryption
   # actions.
   class Crypt
-    def initialize(options={})
-      @options = options
+    def initialize()
+      @options = {
+        path: nil,
+        output_file: nil,
+        protocol: "AES-128-CBC",
+        status: false
+      }
+    end
+
+    # Returns encryption protocol
+    # @return encryption protocol
+    def protocol
+      @options[:protocol]
+    end
+
+    def protocol?
+      unless @options.key?(:protocol)
+        return false
+      end
+
+      true
+    end
+
+    def protocol=(protocol)
+      @options[:protocol] = protocol
     end
 
     # Returns entry file
@@ -64,27 +87,31 @@ module Sekreti
       true
     end
 
-    # Returns the encryption salt
-    # @return encryption salt
-    def salt
-      @options[:salt]
+    # Returns the encryption key
+    # @return encryption key
+    def key
+      @options[:key]
     end
 
-    # Set the encryption salt
-    # @param salt [String] 16 bytes string
+    # Set the encryption key
+    # @param key [String] 16 bytes string
     # @return boolean
-    def salt=(salt)
-      unless salt.length == 16
-        raise StandardError, "Salt must be 16 bytes."
+    def key=(key)
+      if @options[:protocol] == "AES-128-CBC"
+        raise(StandardError, "Key must be 16 bytes long.") if key.length != 16
       end
 
-      @options[:salt] = salt
+      if @options[:protocol] == "AES-256-CBC"
+        raise(StandardError, "Key must be 32 bytes long.") if key.length != 32
+      end
+
+      @options[:key] = key
     end
 
-    # returns true if salt is defined.
+    # returns true if key is defined.
     # @return boolean
-    def salt?
-      unless @options.key?(:salt)
+    def key?
+      unless @options.key?(:key)
         return false
       end
 
@@ -96,7 +123,7 @@ module Sekreti
     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?
+      raise StandardError, "No key defined" unless key?
 
       if Core.encrypt!(@options)
         @options[:status] = true
@@ -110,7 +137,7 @@ module Sekreti
     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?
+      raise StandardError, "No key defined" unless key?
 
       if Core.decrypt!(@options)
         @options[:status] = true
@@ -123,5 +150,11 @@ module Sekreti
     def status?
       @options[:status]
     end
+
+    # Returns the configuration
+    # @return current instance configuration.
+    def dump
+      @options
+    end
   end
 end

data/lib/sekreti/version.rb

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

data/sekreti.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Easy-to-use encryption/decryption library.}
+  spec.description   = %q{Easy-to-use and configure encryption and decryption library based upon OpenSSL. Currently supports AES-128-CBC and AES-256-CBC encryption protocol.}
   spec.homepage      = "https://github.com/atilleh/sekreti"
   spec.license       = "MIT"
 
@@ -31,4 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sekreti
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - atille
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-13 00:00:00.000000000 Z
+date: 2019-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: redcarpet
+  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'
 description: Easy-to-use and configure encryption and decryption library based upon
-  OpenSSL
+  OpenSSL. Currently supports AES-128-CBC and AES-256-CBC encryption protocol.
 email:
 - 'gautierfrancois@outlook.com
 
@@ -103,5 +131,5 @@ requirements: []
 rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
-summary: Easy-to-use encryption/decryption library
+summary: Easy-to-use encryption/decryption library.
 test_files: []