wikk_aes_256 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7070013a13581a329266c4d5bc9a89426a0660c
+  data.tar.gz: bac8c27c2069937c888ba76458dac3e82d984753
+SHA512:
+  metadata.gz: 4518a7b028a35cab529dc4fed027c7e0528dfef0f0aceea19f7979025b5a653e97b327b59d6636a8a26ce159b505fbf05e63eedc6443510baa238be06557e4f1
+  data.tar.gz: 7231b2fb4a7469ca910159efaea9a13b43fc340dcfadb1a3f15c7cd563d25bb063996ca231ac78f9bf851650c60c325d2dae825ca4a0977a0bdfa7d52976eff8

data/History.txt

@@ -0,0 +1,2 @@
+robertburrowes	Mon Jun 20 17:58:30 2016 +1200
+	first commit

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.md
+Rakefile
+lib/wikk_aes_256.rb

data/README.md

@@ -0,0 +1,58 @@
+# wikk_aes
+
+* http://wikarekare.github.com/wikk_aes/
+* Source https://github.com/wikarekare/wikk_aes
+* Gem https://rubygems.org/gems/wikk_aes
+
+## DESCRIPTION:
+
+Class for AES 256 encryption of text. 
+
+## FEATURES/PROBLEMS:
+
+* encrypt takes strings or File (IO) objects
+* calls available to base64 encode/pack encrypted output and unencode/unpack before decryption
+* calls to base64 encode key and initial vector, and WIKK::AES256 accepts key_string and iv_string arguments.
+
+## SYNOPSIS:
+
+```
+require "wikk_aes_256"
+  aes2 = WIKK::AES_256.new
+  File.open("testfile.txt",'r') do |fd|
+    @et = aes2.cipher_to_s(fd)
+  end
+  puts aes2.decrypt(@et, true)
+```
+
+## REQUIREMENTS:
+
+
+## INSTALL:
+
+* sudo gem install wikk_aes_256
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2016
+
+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/Rakefile

@@ -0,0 +1,27 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+Hoe.plugin :yard
+
+Hoe.spec 'wikk_aes_256' do 
+  self.readme_file = "README.md"
+  self.developer( "Rob Burrowes","r.burrowes@auckland.ac.nz")
+  remote_rdoc_dir = '' # Release to root
+  
+  self.yard_title = 'wikk_aes_256'
+  self.yard_options = ['--markup', 'markdown', '--protected']
+end
+
+
+#Validate manfest.txt
+#rake check_manifest
+
+#Local checking. Creates pkg/
+#rake gem
+
+#create doc/
+#rake docs  
+
+#Copy up to rubygem.org
+#rake release VERSION=1.0.1

data/lib/wikk_aes_256.rb

@@ -0,0 +1,176 @@
+module WIKK
+  require "openssl"
+  require 'digest/sha2'
+  require 'base64'
+
+  #Provides AES 256 Encryption, as well as generation of keys and initial vectors, which could be used in other places.
+  # @attr_reader [String] plain_text the decrypted text
+  # @attr_reader [String] cipher_text the encrypted text
+  class AES_256
+    VERSION = "0.1.0"
+    AES_256_CBC = "AES-256-CBC"
+    
+    attr_reader :plain_text, :cipher_text
+    
+    #Initialize
+    #  @param key_string [String] optional base64 key to be used in encryption or decryption. 
+    #    if nil, then key and iv are generated automatically. Recover the key with key_to_s(), or key_iv_to_s()
+    #  @param iv_string [String ] optional base64 iv (initial vector) to be used in the encryption or decryption
+    #    Overwritten by auto generated iv, if key_string is nil. Recover with iv_to_str() or key_iv_to_s().
+    def initialize(key_string = nil, iv_string = nil)
+      if(key_string == nil)
+        gen_key
+        gen_iv
+      else
+        str_to_key(key_string)
+        str_to_iv(iv_string)
+      end
+    end
+    
+    #Generates a new key using Digest SHA256 in @key.
+    #  @return [String] Binary string, @key
+  	def gen_key
+      digest = Digest::SHA256.new
+      digest.update("symetric key")
+      return (@key = digest.digest)
+    end
+    
+    #  @return [String] base64 version of @key
+    def key_to_s
+      return [@key].pack('m')
+    end
+
+    #  @param [String] turns base64 version of key into AES_256_CBC Symetric Key.
+    def str_to_key(base64_keystring)
+      return( @key = base64_keystring.unpack('m')[0] )
+    end
+
+    #Generate random AES_256_CBC initialization vector.
+    #  @return [String] Binary initialization vector @iv
+    def gen_iv
+      return (@iv = OpenSSL::Cipher::Cipher.new(AES_256_CBC).random_iv)
+    end   
+
+    #  @return [String] return Base64 version of initialization vector @iv 
+    def iv_to_s
+      return([@iv].pack('m'))
+    end
+    
+    #  @param [String] turns base64 version of iv into AES_256_CBC initialization vector.
+    #  @return [Array] AES_256_CBC initialization vector @iv.
+    def str_to_iv(base64_iv_string)
+      return (@iv = base64_iv_string.unpack('m')[0])
+    end
+
+    #  @return [String] base64 version of @key
+    #  @return [String] return Base64 version of initialization vector @iv 
+    def key_iv_to_s
+      return key_to_s, iv_to_s
+    end
+      
+    #Encrypts source using AES 256 CBC, using @key and @iv
+    #  @param unencrypted_source [String|File] 
+    #  @return [String] Binary string representing encrypted source
+    def encrypt(unencrypted_source)
+      unencrypted_source = StringIO.new(unencrypted_source) if(unencrypted_source.class == String)
+      aes = OpenSSL::Cipher::Cipher.new(AES_256_CBC)
+      aes.encrypt
+      aes.key = @key
+      aes.iv = @iv
+      @cipher_text = ""
+      while (s = unencrypted_source.read(4096)) != nil do @cipher_text << aes.update(s); end
+      @cipher_text << aes.final
+    end
+    
+    #Converts encrypted source String, @cipher_text, into Base64 String
+    #  @param unencrypted_source [String|File] If present, then this source is encrypted, otherwise assumes already encrypted.
+    #  @return [String] Base64 string representing encrypted source
+    def cipher_to_s(unencrypted_source = nil)
+      encrypt(unencrypted_source) if(unencrypted_source != nil)
+      return [@cipher_text].pack('m')
+    end
+
+    #Decrypts source using AES 256 CBC, using @key and @iv
+    #  @param encrypted_source [String|File] 
+    #  @param base64_source [Boolean] if true, then source is assumed to be base64 encoded.
+    #  @return [String] String representing the original unencypted source
+    def decrypt(encrypted_source, base64_source = false)
+      encrypted_source = StringIO.new(encrypted_source) if(encrypted_source.class == String)
+      read_count = base64_source ? 5464:4096
+      decode_cipher = OpenSSL::Cipher::Cipher.new(AES_256_CBC)
+      decode_cipher.decrypt
+      decode_cipher.key = @key
+      decode_cipher.iv = @iv
+      @plain_text = ""
+      while (et = encrypted_source.read(read_count)) != nil do 
+        @plain_text << (base64_source ? decode_cipher.update(et.unpack('m')[0]) : decode_cipher.update(et))
+      end
+      @plain_text << decode_cipher.final
+    end
+    
+    #Generates a new key using Digest SHA256 in @key.
+    #  @return [String] Base64 encoded string, @key
+  	def self.gen_key_to_s
+  	  aes = self.new
+  	  return aes.key_to_s
+    end
+
+    #Generate random AES_256_CBC initialization vector.
+    #  @return [String] Base64 encoded initialization vector @iv
+  	def self.gen_iv_to_s
+  	  aes = self.new
+  	  return aes.iv_to_s
+    end
+    
+    #Generates a new key using Digest SHA256 in @key, and random AES_256_CBC initialization vector in @iv
+    #  @return [String] Base64 encoded string, @key
+    #  @return [String] Base64 encoded initialization vector @iv
+    def self.gen_key_iv_to_s
+  	  aes = self.new
+  	  return aes.key_to_s, aes.iv_to_s
+    end
+      
+    #Encrypts source using AES 256 CBC, using @key and @iv
+    #  @param unencrypted_source [String|File] 
+    #  @param key_string [String] optional base64 key to be used in encryption or decryption. 
+    #    if nil, then key and iv are generated automatically. Recover the key with key_to_s(), or key_iv_to_s()
+    #  @param iv_string [String ] optional base64 iv (initial vector) to be used in the encryption or decryption
+    #    Overwritten by auto generated iv, if key_string is nil. Recover with iv_to_str() or key_iv_to_s().
+    #  @return [String] Binary string representing encrypted source
+    #  @return [String] base64 key, @key, so later decryption can be done
+    #  @return [String] base64 initial vector, @iv, so later decryption can be done
+    def self.encrypt(unencrypted_source, key_string = nil, iv_string = nil)
+      aes = self.new(key_string, iv_string)
+      return aes.encrypt(unencrypted_source), aes.key_to_s, aes.iv_to_s 
+    end
+    
+    #Converts encrypted source String, @cipher_text, into Base64 String
+    #  @param unencrypted_source [String|File] which must be present, as AES_256 class is created here.
+    #  @param key_string [String] optional base64 key to be used in encryption or decryption. 
+    #    if nil, then key and iv are generated automatically. Recover the key with key_to_s(), or key_iv_to_s()
+    #  @param iv_string [String ] optional base64 iv (initial vector) to be used in the encryption or decryption
+    #    Overwritten by auto generated iv, if key_string is nil. Recover with iv_to_str() or key_iv_to_s().
+    #  @return [String] Base64 string representing encrypted source
+    #  @return [String] base64 key, @key, so later decryption can be done
+    #  @return [String] base64 initial vector, @iv, so later decryption can be done
+    def self.cipher_to_s(unencrypted_source, key_string = nil, iv_string = nil)
+      aes = self.new(key_string, iv_string)
+      return aes.cipher_to_s(unencrypted_source), aes.key_to_s, aes.iv_to_s 
+    end
+    
+    #Creates an AES class and then Decrypts source using AES 256 CBC, using @key and @iv
+    #  @param encrypted_source [String|File] 
+    #  @param base64_source [Boolean] if true, then source is assumed to be base64 encoded.
+    #  @param key_string [String] optional base64 key to be used in encryption or decryption. 
+    #    if nil, then key and iv are generated automatically. Recover the key with key_to_s(), or key_iv_to_s()
+    #  @param iv_string [String ] optional base64 iv (initial vector) to be used in the encryption or decryption
+    #    Overwritten by auto generated iv, if key_string is nil. Recover with iv_to_str() or key_iv_to_s().
+    #  @return [String] String representing the original unencypted source
+    def self.decrypt(encrypted_source, base64_source=false, key_string = nil, iv_string = nil)
+      aes = self.new(key_string, iv_string)
+      return aes.decrypt(encrypted_source, base64_source)
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: wikk_aes_256
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Burrowes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+description: Class for AES 256 encryption of text.
+email:
+- r.burrowes@auckland.ac.nz
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+files:
+- History.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/wikk_aes_256.rb
+homepage: http://wikarekare.github.com/wikk_aes/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--markup"
+- markdown
+- "--protected"
+- "--title"
+- wikk_aes_256
+- "--quiet"
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Class for AES 256 encryption of text.
+test_files: []