aion-enigma 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 123f2307cf57a446b1c46823bd3507bd83ce4784
+  data.tar.gz: 9cac96a9c1fd6ab3c6a591dd303f450ceb5a055c
+SHA512:
+  metadata.gz: 634e1f259feed493be4703935b9409461e6bc1dbb52c201551b09dcc81ca5484a73ee1d5c01020313b7fb45a8673e3d1f52e3c44af5bd9d8ee59cbcbe32050b8
+  data.tar.gz: 9fdcc2e6e9951444e2d4293fbef8180f1f8233fe4bfbf3f91cabbf862a53aac89faa85c5b3fb9b8d818f8942376eb6a7e6f0a3c0ca5317e8874bfa8118ba04bc

data/README.md

@@ -0,0 +1,27 @@
+Enigma
+======
+
+Enigma is a small utility for encrypting/decrypting a string based on a shared secret using AES-265-CBC.
+
+Install
+-------
+
+Install gem via git
+```
+gem 'aion-enigma'
+```
+
+Usage
+-----
+
+```ruby
+secret_message = 'this is a secret message'
+shared_secret  = 'some shared secret'
+
+enigma = Enigma.new(shared_secret)
+encrypted_message = enigma.encrypt(secret_message)
+# encrypted_message ≈> 'Gn3AZKG9aqv+ALTfI9ZbuQ==|7hI5iN1Jdm73zQB1nTBngX07SaX60nuirWQRtNygIgE='
+
+message = enigma.decrypt(encrypted_message)
+# message => 'this is a secret message'
+```

data/lib/aion-enigma.rb

@@ -0,0 +1 @@
+require 'enigma'

data/lib/enigma.rb

@@ -0,0 +1,110 @@
+require 'openssl'
+require 'base64'
+
+class Enigma
+
+  class EncryptError < StandardError; end
+  class DecryptError < StandardError; end
+
+  # Creates an instance of Enigma using given shared secret
+  # @raise ArgumentError if secret is not a string
+  def initialize(secret)
+    unless secret.is_a? String
+      fail ArgumentError, 'secret must be a string'
+    end
+    @key = Digest::SHA1.hexdigest(secret)
+  end
+
+  # Encrypts a string.
+  #
+  # @param message a string to encrypt
+  # @return a String
+  # @raise ArgumentError if message is not a string
+  # @raise EncryptError if encryption failed
+  def encrypt(message)
+    unless message.is_a? String
+      fail ArgumentError, 'message must be a string'
+    end
+
+    begin
+      cipher = OpenSSL::Cipher.new('aes-256-cbc')
+
+      cipher.encrypt
+      cipher.key = @key
+
+      cipher.iv = iv = cipher.random_iv
+
+      encrypted = cipher.update(message)
+      encrypted << cipher.final
+
+      pack(iv, encrypted)
+    rescue => _
+      fail EncryptError, 'Could not encode message.'
+    end
+  end
+
+  # Decrypts an encrypted messages.
+  # If the secret does not match the encrypted message then
+  # an Enigma::DecryptError is raised.
+  #
+  # @param encrypted_message a string to decrypt (outputted by Enigma#encrypt)
+  # @return a String with the decrypted message
+  # @raise ArgumentError if encrypted_message is not a string
+  # @raise DecryptError if Decryption failed
+
+  def decrypt(encrypted_message)
+    unless encrypted_message.is_a? String
+      fail ArgumentError, 'encrypted_message must be a string'
+    end
+
+    begin
+      iv, encrypted_message = unpack(encrypted_message)
+
+      cipher = OpenSSL::Cipher.new('aes-256-cbc')
+      cipher.decrypt
+      cipher.key = @key
+
+      cipher.iv = iv
+
+      decrypted = cipher.update(encrypted_message)
+      decrypted << cipher.final
+
+      decrypted
+    rescue => _
+      fail DecryptError, 'Could not decode encrypted message.'
+    end
+  end
+
+  protected
+
+  # Packing the encrypted message into a string.
+  #
+  # Enigma#pack and Enigma#unpack can be overridden from a subclass.
+  # Just make sure that the following still holds:
+  #
+  #     iv2, encrypted2 = unpack(pack(iv1, encrypted1)
+  #     iv1 == iv2 and encrypted1 == encrypted2
+  #
+  # @param iv the random iv (bytes) generated by the cipher
+  # @param encrypted the encrypted bytes
+  # @return String with serialized iv and encrypted parameters
+  def pack(iv, encrypted)
+    [iv, encrypted].map { |x| Base64.encode64(x).strip }.join('|')
+  end
+
+  # Unpacking the encrypted_message into an array of iv and encrypted data.
+  #
+  # Enigma#pack and Enigma#unpack can be overridden from a subclass.
+  # Just make sure that the following still holds:
+  #
+  #     iv2, encrypted2 = unpack(pack(iv1, encrypted1)
+  #     iv1 == iv2 and encrypted1 == encrypted2
+  #
+  # @param encrypted_message as outputted by Enigma#pack
+  # @return Array containing iv bytes and encrypted bytes
+  def unpack(encrypted_message)
+    encrypted_message.split('|').map { |m| Base64.decode64(m) }
+  end
+
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: aion-enigma
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Andersen
+- Eugene Zainchkovskyy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+description: Small utility for encrypting/decrypting a string based on a shared secret.
+  Based on AES-265-CBC.
+email:
+- michael@aion.dk
+- eugene@3bytesahead.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/aion-enigma.rb
+- lib/enigma.rb
+homepage: https://github.com/aion-dk/enigma
+licenses:
+- MIT
+metadata: {}
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Encryption utility based on AES
+test_files: []