wikk_aes_256 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d15a628c0fd990371636a7d2e066768dc71a3fdd
-  data.tar.gz: 3becb7b50ffe9eb2c1aa1d29a424e67bb44de4d9
+SHA256:
+  metadata.gz: 5dd425fdcb527392c69b96465b764aab84ef72a8f70420a98400ae7d6aea894b
+  data.tar.gz: 8e993f98f23cc6a309dbd5da231d7ef0cac18f6fac9941a5136ee4678e988f63
 SHA512:
-  metadata.gz: e5c3b086b36a0124de016622518ad9d15ae20132bc27e7b9a04890d9d41350ff71618a92feae34fef8a956e53f6a0c8f98768237306c9da4473015e9b0071366
-  data.tar.gz: 28cc7ba2ec932b8a2cbcab44fe00a8048a87bfc20202d8dd2b4218dcd89165f2730ed1af4eddd8266b64525b7db3b5ebf38c77c63b912be974ce4690c2a37210
+  metadata.gz: dcfe57a6287556cfe0b1414fa2c8e417544e0e2f00ed159d2f889c097ca6c73512c552f510b3da7022fae48efbbef2cb25d4bb7761331dd4c8914acf14777c1d
+  data.tar.gz: bc83fcf0f6f2fefe986f2a194a5e8582cb410de4c1d006ea61a3179127102e23a6773f323ff927474743bebb7707bab720cf057edf40c4fafb675da3af702d71

data/History.txt

@@ -1,3 +1,37 @@
+robertburrowes	Sat Apr 15 17:33:00 2023 +1200
+	Use SecureRandom for generating the key, if none given.
+robertburrowes	Sat Apr 15 17:30:45 2023 +1200
+	show encrypted text too.
+robertburrowes	Sun Jun 5 18:46:28 2022 +1200
+	ensure we use bash
+robertburrowes	Sun Jun 5 18:21:48 2022 +1200
+	#{PROJECT} release 0.1.7
+robertburrowes	Sun Jun 5 18:18:15 2022 +1200
+	left out require stringio
+robertburrowes	Sun Oct 25 22:11:06 2020 +1300
+	Tidy up yard doc comments
+robertburrowes	Sun Oct 25 17:45:35 2020 +1300
+	Chdir to cd as Mac doesn't look to have chdir in sh
+robertburrowes	Sun Oct 25 13:51:16 2020 +1300
+	New hoe layout
+robertburrowes	Sun Oct 25 13:50:46 2020 +1300
+	formatting
+robertburrowes	Sun Oct 25 13:50:30 2020 +1300
+	now including this in repo
+robertburrowes	Sun Oct 25 13:50:02 2020 +1300
+	Move dev shell scripts into sbin
+robertburrowes	Tue Apr 14 21:21:06 2020 +1200
+	moved test data to its own dir
+robertburrowes	Tue Apr 14 14:32:08 2020 +1200
+	mv test data to test/data
+robertburrowes	Mon Apr 13 22:55:45 2020 +1200
+	Add __dir__ path to access testfile
+robertburrowes	Tue Apr 10 11:53:52 2018 +1200
+	Inc Version
+robertburrowes	Tue Apr 10 11:53:43 2018 +1200
+	Inc version
+robertburrowes	Tue Apr 10 11:53:33 2018 +1200
+	Inc version
 robertburrowes	Tue Apr 10 11:50:22 2018 +1200
 	OpenSSL::Cipher::Cipher.new deprecated in favour of OpenSSL::Cipher.new
 robertburrowes	Fri Jun 24 19:56:31 2016 +1200

data/README.md

@@ -1,8 +1,8 @@
-# wikk_aes
+# wikk_aes_256
 
-* http://wikarekare.github.com/wikk_aes/
-* Source https://github.com/wikarekare/wikk_aes
-* Gem https://rubygems.org/gems/wikk_aes
+* Docs :: https://wikarekare.github.io/wikk_aes_256/
+* Source :: https://github.com/wikarekare/wikk_aes_256
+* Gem :: https://rubygems.org/gems/wikk_aes_256
 
 ## DESCRIPTION:
 

data/Rakefile

@@ -1,27 +1,25 @@
 # -*- 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")
+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']
+  self.yard_options = [ '--markup', 'markdown', '--protected' ]
 end
 
+# Validate manfest.txt
+# rake check_manifest
 
-#Validate manfest.txt
-#rake check_manifest
-
-#Local checking. Creates pkg/
-#rake gem
+# Local checking. Creates pkg/
+# rake gem
 
-#create doc/
-#rake docs  
+# create doc/
+# rake docs
 
-#Copy up to rubygem.org
-#rake release VERSION=1.0.1
+# Copy up to rubygem.org
+# rake release VERSION=1.0.1

data/lib/wikk_aes_256.rb

@@ -1,179 +1,199 @@
-module WIKK
-  require "openssl"
-  require 'digest/sha2'
-  require 'base64'
+require 'openssl'
+require 'securerandom'
+require 'base64'
+require 'stringio'
 
-  #Provides AES 256 Encryption, as well as generation of keys and initial vectors, which could be used in other places.
+# Stay in our own namespace
+module WIKK
+  # 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.6"
-    AES_256_CBC = "AES-256-CBC"
-    
+    VERSION = '0.1.8'
+    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. 
+
+    # 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
+    # @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
+      if key_string.nil?
+        gen_key(key_length: 32)
       else
         str_to_key(key_string)
       end
 
-      if iv_string == nil
+      if iv_string.nil?
         gen_iv
       else
         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)
+
+    # Generates a new binary key in @key, using SecureRandom.
+    #
+    # @return [String] Binary string, @key
+    def gen_key(key_length: 32)
+      @key = SecureRandom.gen_random(key_length)
     end
-    
-    #  @return [String] base64 version of @key
+
+    # Convert key to a base64 string
+    #
+    # @return [String] base64 version of @key
     def key_to_s
-      return [@key].pack('m').chomp
+      return [ @key ].pack('m').chomp
     end
 
-    #  @param [String] turns base64 version of key into AES_256_CBC Symetric Key.
+    # Convert a base64 string into a key
+    #
+    # @param [String] converts base64 version of key into AES_256_CBC Symetric Key.
+    # @return [String] Binary string, @key
     def str_to_key(base64_keystring)
-      return( @key = base64_keystring.unpack('m')[0] )
+      return( @key = base64_keystring.unpack1('m') )
     end
 
-    #Generate random AES_256_CBC initialization vector.
-    #  @return [String] Binary initialization vector @iv
+    # Generate random AES_256_CBC initialization vector.
+    #
+    # @return [String] Binary initialization vector @iv
     def gen_iv
       return (@iv = OpenSSL::Cipher.new(AES_256_CBC).random_iv)
-    end   
+    end
 
-    #  @return [String] return Base64 version of initialization vector @iv 
+    # Convert initialization vector to base64 string
+    #
+    # @return [String] return Base64 version of initialization vector @iv
     def iv_to_s
-      return([@iv].pack('m')).chomp
+      return [ @iv ].pack('m').chomp
     end
-    
-    #  @param [String] turns base64 version of iv into AES_256_CBC initialization vector.
-    #  @return [Array] AES_256_CBC initialization vector @iv.
+
+    # Convert base64 string into an initialization vector
+    #
+    # @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])
+      return (@iv = base64_iv_string.unpack1('m'))
     end
 
-    #  @return [String] base64 version of @key
-    #  @return [String] return Base64 version of initialization vector @iv 
+    # Convert key and the initialization vector into base64 strings
+    #
+    # @return [String,String] base64 version of @key;
+    #                         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
+
+    # 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)
+      unencrypted_source = StringIO.new(unencrypted_source) if unencrypted_source.instance_of?(String)
       aes = OpenSSL::Cipher.new(AES_256_CBC)
       aes.encrypt
       aes.key = @key
       aes.iv = @iv
-      @cipher_text = ""
+      @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
+
+    # 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').chomp
+      encrypt(unencrypted_source) if unencrypted_source != nil
+      return [ @cipher_text ].pack('m').chomp
     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
+    # 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
+      encrypted_source = StringIO.new(encrypted_source) if encrypted_source.instance_of?(String)
+      read_count = base64_source ? 5464 : 4096
       decode_cipher = OpenSSL::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))
+      @plain_text = ''
+      while (et = encrypted_source.read(read_count)) != nil
+        @plain_text << (base64_source ? decode_cipher.update(et.unpack1('m')) : 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
-        digest = Digest::SHA256.new
-        digest.update("symetric key")
-        return ([digest.digest].pack('m')).chomp
-    end
-
-    #Generate random AES_256_CBC initialization vector.
-    #  @return [String] Base64 encoded initialization vector @iv
-  	def self.gen_iv_to_s
-      return ([OpenSSL::Cipher.new(AES_256_CBC).random_iv].pack('m')).chomp
-    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
+
+    # Generates a random base64 key.
+    #
+    # @return [String] Base64 encoded string, @key
+    def self.gen_key_to_s(key_length: 32)
+      SecureRandom.base64(key_length)
+    end
+
+    # Generate random AES_256_CBC initialization vector.
+    #
+    # @return [String] Base64 encoded initialization vector @iv
+    def self.gen_iv_to_s
+      return [ OpenSSL::Cipher.new(AES_256_CBC).random_iv ].pack('m').chomp
+    end
+
+    # Generates a new key using Random string in @key, and random AES_256_CBC initialization vector in @iv
+    #
+    # @return [String,String] Base64 encoded string, @key;
+    #                  Base64 encoded initialization vector @iv
     def self.gen_key_iv_to_s
-  	  return self.gen_key_to_s, self.gen_iv_to_s
+      return self.gen_key_to_s, self.gen_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. 
+
+    # 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
+    # @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
+    # @return [String,String,String] Binary string representing encrypted source;
+    #                                base64 key, @key, so later decryption can be done;
+    #                                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 
+      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. 
+
+    # 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
+    # @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
+    # @return [String,String,String] Base64 string representing encrypted source;
+    #                                base64 key, @key, so later decryption can be done;
+    #                                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 
+      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. 
+
+    # 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
+    # @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)
+    # @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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikk_aes_256
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Rob Burrowes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-yard
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.25'
 description: Class for AES 256 encryption of text.
 email:
 - r.burrowes@auckland.ac.nz
@@ -53,11 +53,11 @@ files:
 - README.md
 - Rakefile
 - lib/wikk_aes_256.rb
-homepage: http://wikarekare.github.com/wikk_aes/
+homepage: https://wikarekare.github.io/wikk_aes_256/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--markup"
 - markdown
@@ -78,9 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Class for AES 256 encryption of text.
 test_files: []