rubyment 0.4.25421176 → 0.4.25421266

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c689632d21680d8cfef43e14447f3bfc425d50c4
-  data.tar.gz: c8061a2fd5fd6cddd9e100218da29cd26b273bbf
+  metadata.gz: f3cf5f393692d86f56ec7ae005f248e37f27984d
+  data.tar.gz: 81765d975abbb790820c0de5db2b5a1f61ff5c8a
 SHA512:
-  metadata.gz: 914ddf325040d68c4682f460b02d11c0c75d00cd36f259bc68c0579471ca2299cff04464c7ee4065a23b6391ce68dcc82b8069b094bd5415482e72cf28c08009
-  data.tar.gz: 002f2b57542e083a5321fe8da41f05f1558c9b06ffde9f5b3fbf844892968c7be2c992807027c885343ccd759530471ff100c2b04632716fe0707e81e8a42efc
+  metadata.gz: 46f41aaeadd44170dbc8472520198f97043b719dc3a1b6ae3fe2678de5a22e565ad118584192a95c34903cdf521108b79889cc1177512e4c175ae6961ece36b4
+  data.tar.gz: da2b1a63e53cddb54b654d8c353b08a655ffa554dcf2d5863aef9efe78afc999143c2e184e242b9ae2d42d52455471dc43c05fdcdd189822237c44bf4decdced

data/lib/rubyment.rb

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
 # Collection of Ruby functions
-# * output
-# normally outputs to STDERR, with
+# === Output
+# normally outputs to +STDERR+, with
 # no mercy
 # STDOUT, just qualified output:
 # only if the function is expected
@@ -431,23 +431,23 @@ class Rubyment
   end
 
 
-  # decrypt encrypted (string), having password (string), iv (string),
-  # big_file(bool) is a flag to set padding to 0.
+  # decipher the data encoded by enc
   #
-  # planned changes:
-  # add metadata information to encrypted
-  # decipher.key = Digest::SHA256.hexdigest is not the best security.
-  # encrypted could be called base64_encrypted
-  # iv could be called base64_iv
-  # get only one string, not encrypted and iv (see enc planned changes)
-  # remove dependence on the uniqueness of ending
+  # @param [Array] args, an +Array+ whose elements are expected to be:
+  # +password+:: [String, nil] password to be used to encryption.
+  # +base64_iv+:: [String, nil] initialization vectors encoded with Base64
+  # +base64_encrypted+:: [String, nil] ciphered data (without metadata) encoded with Base64
+  # +ending+:: [nil] deprecated
+  # +base64_salt+:: [String, nil] #generate_pbkdf2_key salt encoded with Base64
+  # +base64_iter+:: [String, nil] #generate_pbkdf2_key iterations encoded with Base64
   #
+  # @return [String] decoded data
   def dec args=ARGV
     require 'openssl'
     require 'base64'
     memory = @memory
     static_end_key = memory[:static_end_key]
-    password, iv, encrypted, ending, base64_salt, base64_iter = args
+    password, base64_iv, base64_encrypted, ending, base64_salt, base64_iter = args
     salt = Base64.decode64 base64_salt
     iter = Base64.decode64 base64_iter
     ending = ending.to_s.split("\0").first || static_end_key
@@ -460,8 +460,8 @@ class Rubyment
     decipher.padding = 0
 
     decipher.key = key || (Digest::SHA256.hexdigest password)
-    decipher.iv = Base64.decode64 iv
-    plain = decipher.update(Base64.decode64 encrypted) + decipher.final
+    decipher.iv = Base64.decode64 base64_iv
+    plain = decipher.update(Base64.decode64 base64_encrypted) + decipher.final
     # split is not the ideal, if ever ending is duplicated it won't
     # work. also may be innefficient.
     (plain.split ending).first
@@ -547,14 +547,23 @@ class Rubyment
     shell_dec_output [pw_plain]
   end
 
-  # encrypt data (string), with password (string)
-  # returns [base64_iv, base64_encrypted]
+
+  # encode data into aes-128-cbc cipher protected by a key generated
+  # by #generate_pbkdf2_key, using given +password+, +salt+, +iter+
   #
-  # planned changes:
-  # add metadata information to encrypted
-  # return only one string, having encrypted + metadata (having iv)
-  # add string length to metadata
-  # decipher.key = Digest::SHA256.hexdigest is not the best security.
+  # @param [Array] args, an +Array+ whose elements are expected to be:
+  # +password+:: [String, nil] password to be used to encryption.
+  # +data+:: [String, nil] data to be encoded data
+  # +ending+:: [nil] deprecated
+  # +salt+:: [String, nil] #generate_pbkdf2_key salt argument
+  # +iter+:: [String, nil] #generate_pbkdf2_key iterations argument
+  #
+  # @return @param [Array] an +Array+ whose elements are expected to be:
+  # +base64_encrypted+:: [String, nil] ciphered data (without metadata) encoded with Base64
+  # +base64_iv+:: [String] initialization vectors encoded with Base64
+  # +base64_salt+:: [String] #generate_pbkdf2_key salt encoded with Base64
+  # +base64_iter+:: [String] #generate_pbkdf2_key iterations encoded with Base64
+  # +base64_key+::  [String] #generate_pbkdf2_key return value
   #
   def enc args=ARGV
     require 'openssl'
@@ -762,10 +771,10 @@ class Rubyment
   # an alternative interface to dec -- reads password if
   # nil or empty.
   #
-  # @param [Array] args Defaults to +ARGV+. Elements:
-  # * +data+ [String, nil] data to be encrypted, If empty or nil, read (without
-  # echo) from @memory[:stdin], which defaults to STDIN
-  # * +password+ [String, nil] password to be used to encryption.
+  # @param [Array] args, an +Array+ whose elements are expected to be:
+  # +iv+:: [String, nil] 
+  # If empty or nil, read (without echo) from @memory[:stdin], which defaults to STDIN
+  # +password+:: [String, nil] password to be used to encryption.
   # If empty or nil, read (without echo) from @memory[:stdin], which defaults to STDIN
   #
   # @return [TrueClass, FalseClass] depending on whether test succeeds.
@@ -809,8 +818,14 @@ class Rubyment
 
 
   # test for enc and dec.
-  # good idea is to use this function once with the desired
-  # data, password, and use the stderr output
+  #
+  # @param [Array] args, an +Array+ whose elements are expected to be:
+  # +data+:: [String, nil] data to be encrypted.
+  # If empty or nil, read (without echo) from @memory[:stdin], which defaults to STDIN
+  # +password+:: [String, nil] password to be used to encryption.
+  # If empty or nil, read (without echo) from @memory[:stdin], which defaults to STDIN
+  #
+  # @return [TrueClass, FalseClass] depending on whether test succeeds.
   def test__enc_dec args=ARGV
     stderr = @memory[:stderr]
     data, password = args

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyment
 version: !ruby/object:Gem::Version
-  version: 0.4.25421176
+  version: 0.4.25421266
 platform: ruby
 authors:
 - Ribamar Santarosa