filesafe 3.0.0 → 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b861521a8fb52cf218a3222749b3daf51c664f2
+  data.tar.gz: f81c942da0d839c87694778cc3c8a5c2d06ab12b
+SHA512:
+  metadata.gz: c86db90a87c2de7d0bbc55870bda68605ed701126c108dbf2626dfe41c49fa5e40b877e9f418889e05d117eefd01916cd73fe68a0e320e91fb1f6eb3b8e97f88
+  data.tar.gz: fa49b8818edbc5a99f6a1cf23a91381950d07ad9fa358f2416f52f42b503cb8a13a0d8a5732cb57a661600fd1b7d6602c11d8b8cbf0456ae058a9538410ee0f2

data/README.txt

@@ -114,7 +114,7 @@ This script requires or relies on:
   tempfile      -- for temporary file creation
 
 It uses the following gems:
-  pbkdf2        -- for the password-based key derivitive function PBKDF2
+  pbkdf2-ruby   -- for the password-based key derivitive function PBKDF2
   highline      -- for reading a password/passphrase from a terminal
 
 

data/Rakefile

@@ -1,10 +1,11 @@
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/testtask'
 
 gemspec = Gem::Specification.new do |spec|
   spec.name         = 'filesafe'
   spec.version      = File.open('VERSION.txt','r').to_a.join.strip
+  spec.licenses     = ['MIT']
   spec.date         = File.mtime('VERSION.txt')
   spec.author       = 'Aaron D. Gifford'
   spec.homepage     = 'http://www.aarongifford.com/computers/filesafe/'
@@ -22,16 +23,16 @@ gemspec = Gem::Specification.new do |spec|
     'test/*'
   ]
   spec.executables = [ 'filesafe' ]
-  spec.add_dependency('pbkdf2', '>= 0.1.0')
-  spec.add_dependency('highline', '>= 1.6.1')
+  spec.add_runtime_dependency 'pbkdf2-ruby', '~> 0.2', '>= 0.2.0'
+  spec.add_runtime_dependency 'highline', '~>1.6.1', '>= 1.6.1'
 end
 
-Rake::GemPackageTask.new(gemspec) do |pkg|
+Gem::PackageTask.new(gemspec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
 end
 
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.name     = 'rdoc'
   rdoc.main     = 'README.txt'
   rdoc.rdoc_dir = 'doc'

data/VERSION.txt

@@ -1 +1 @@
-3.0.0
+3.1.0

data/lib/filesafe.rb

@@ -76,9 +76,9 @@ module FileSafe
   # Read a passphrase from a terminal.
   def self.getphrase(check=false)
     begin
-      phrase = HighLine.new.ask('Passphrase: '){|q| q.echo = '*' ; q.overwrite = true }
+      phrase = HighLine.new.ask('Passphrase: '){|q| q.echo = '*' ; q.overwrite = true ; q.validate = nil }
       return phrase unless check
-      tmp = HighLine.new.ask('Retype passphrase: '){|q| q.echo = '*' ; q.overwrite = true }
+      tmp = HighLine.new.ask('Retype passphrase: '){|q| q.echo = '*' ; q.overwrite = true ; q.validate = nil }
       return phrase if tmp == phrase
     rescue Interrupt
       exit -1
@@ -91,7 +91,7 @@ module FileSafe
 
   # Encrypt a file with the supplied passphrase--or if none is supplied,
   # read a passphrase from the terminal.
-  def self.encrypt(file, passphrase=nil, notemp=true)
+  def self.encrypt(file, passphrase=nil, notemp=true, debug_params=nil)
     raise "Cannot encrypt non-existent file: #{file.inspect}" unless File.exist?(file)
     raise "Cannot encrypt unreadable file: #{file.inspect}" unless File.readable?(file)
     raise "Cannot encrypt unwritable file: #{file.inspect}" unless File.writable?(file)
@@ -127,10 +127,21 @@ module FileSafe
       passphrase = getphrase(true)
     end
 
-    ## Use secure random data to populate salt, key, and IV:
-    salt      = SecureRandom.random_bytes(SALT_LEN)  ## Acquire some fresh salt
-    file_key  = SecureRandom.random_bytes(KEY_LEN)   ## Get some random key material
-    file_iv   = SecureRandom.random_bytes(IV_LEN)    ## And a random initialization vector
+    ## Use secure random data to populate salt, key, and iv (unless debugging data is provided):
+    if debug_params.nil?
+      file_key  = SecureRandom.random_bytes(KEY_LEN)   ## Get some random key material
+      file_iv   = SecureRandom.random_bytes(IV_LEN)    ## And a random initialization vector
+      salt      = SecureRandom.random_bytes(SALT_LEN)
+    else
+      ## Manually-provided debugging/testing data will be used instead
+      ## (not recommended unless testing/debugging):
+      raise "Invalid debugging parameter data provided!" unless debug_params.is_a?(String) &&
+                                                         debug_params.encoding == Encoding::BINARY &&
+                                                         debug_params.size == SALT_LEN + KEY_LEN + IV_LEN
+      salt     = debug_params.slice!(0,SALT_LEN)
+      file_key = debug_params.slice!(0,KEY_LEN)
+      file_iv  = debug_params
+    end
 
     ## Encrypt the file key and IV using password-derived keying material:
     keymaterial = pbkdf2(passphrase, salt, KEY_LEN + IV_LEN)

data/test/test_cli.rb

@@ -3,6 +3,7 @@
 
 require 'test/unit'
 require 'digest/sha2'
+require_relative '../lib/filesafe.rb'
 
 class FileSafeCLITest < Test::Unit::TestCase
   FILESAFE = File.join(File.dirname(__FILE__), '..', 'bin', 'filesafe')

data/test/test_decrypt.rb

@@ -5,19 +5,96 @@ require 'test/unit'
 require_relative '../lib/filesafe.rb'
 
 class FileSafeDecryptTest < Test::Unit::TestCase
+  ## Unicode UTF-8 endash character as ASCII-8BIT binary two-byte, two-character string
+  ENDASH = ["2014"].pack('H*')
+
+  ## Encrypted ciphertext:
   CIPHERTEXT = [
-    "60e8aacea874e36f39fef5f51cf727252359c575230b7306b6379194" +
-    "12bc53e9106ddaecc0ded13503e6ef9d3ff9f0285bb133d3d88464c0" +
-    "eea4f728ae509942a4e8be070a70d49b8668ddbda2102412ca42c917" +
-    "bd74c824ae6b35bb697a0fccd8f0822e310f96bfc34546e289e6dbed" +
-    "f3dd30eca6585ad344593ca65f6aa323722a29c1c19257b135756340" +
-    "7a88de6a92a85dae5dd9ea0cb8a2ccaf3c45bace571cb0c791186837" +
-    "a3a6ff650545286afbd75087b42582da571521fbc74fa3499dc22ebc" +
-    "8482e13c4055313b38a0cf79"].pack('H*')
+    "cda462fe3b2ec9f141fcec6e32198effcb0ed661c35af78878c1e6fb52f5e798" +
+    "552e2e02c080cb37aaa298d2a27831d4dabe111101107ee85b21e7b5d91262f1" +
+    "f6bf0c63dee422b0a39bbd662202e7cf85feab6c50216b812504119e37f876ce" +
+    "baa1a8d402614cfdd5e40a725f0229e19c046f00c8dc264a481b22fece930113" +
+    "85debf353626c7dcc34747b5d766ec979d69cf61d4a9bf0db218d4eda7c2b9f9" +
+    "e045ac11ebd034caad05fe318aad9cc85500be80b2ff398d62958cb82ee0a583" +
+    "b3f0512ef2f9a09dc4dee2e7250ee8db3ce720d84c7f4409e8852ab582118410" +
+    "06f9b26163bd0262c7eb7d239c2a66b7228e2372d6bdc9f32dced48e4387829a" +
+    "3358abfaf8dff19651e7d06eb8f06dd181df78ced880c1ae4e4aa8e4f2e58d18" +
+    "e8603ca8714081e935e1b5d3916de4bf1f3f083ab1b0a70abfd6bf5a25244032" +
+    "9327a4da7e1b28e13bddc660ae9e4426ec5bc0e28eba2f794e8ed5c26c9c6717" +
+    "e81d194ca2e0e135c3e89a87241d75279eb11352e9ccbbf973de265ebf173916" +
+    "421e3c5575350cdd4ff0adb8008aa2ced5ae855940a6d7a221dd651340a4c361" +
+    "c1e31e7c6ad4ca6156632cd5f92c48990275b53aca0251d89d61fb25635c965c" +
+    "57e615ba69f54cff5ca8b56607e71c3f1a76c81ceb86ab99216da0932b09c72e" +
+    "46aae92870105a7c9613acf9d40520692370c1c30249870ba9f0914514389693" +
+    "8a3c06414ff868511b52c5fa6d2465c5cad3002724852998ea096ad9eea02b5c" +
+    "98faf9954240000938a2ac152b4bcb836fb1fe77ff0f6a3fa0cfebc4d93ac8fc" +
+    "9da2c7171319de5a7b034485abb1fbff7ca323be0240394e0cd32d0cfa30c52d" +
+    "ea5d02569b95eec39b8bd64559873fdf7eda67523c2fe0234883a0f7e98571ee" +
+    "80176609f776be278f7f8665951689b01f6af2ef3002bc1ade88aa398d44039f" +
+    "b996d4a094c74925020740573b0c4df4a39cdc689280f535d8e2603fc2c0d4c0" +
+    "909933efbd4b99a56564084bab6be5198e0af1d3217ca29def5b422c270c3076" +
+    "4af961c2e47d57d520d664e920645a438d339dcaba36246ce4d58fd858e53ceb" +
+    "7bbc42cc559eee525f3790810a5e647a7c444308ce47bd61cdfbd416fb935cdf" +
+    "f467e9c810c3127c53eb7abe5ca39c3ce98c5b91b3f0696c13c14344717d565d" +
+    "e34163cc0af075ef05bda600eeac2c60779b29fdf060e612dc6dd4d81e4c5a38" +
+    "5be05409a153177bad7349362c320664043980dd960f923a2de274f01b6b9397" +
+    "e24fcd61cd16c10c79649574e7f2874e71dbc563b2b6807359f0799314189000" +
+    "6e211a033058adec7a7e58349342803cc784e1e989f1bc552c0a13753ad43661" +
+    "71de7f01d35b75e4143a59d738b3b6bd3b45609bdca7996d60564fce0e12df2e" +
+    "4658d33b7db5587f431893b44c199d475f7b47a436171d66a6a6d4575c80c6c9" +
+    "0f847223367c8c91a74fad3d27cc954ed72640fff84fc33cfb9b4acdef3e2b7c" +
+    "810d52e507c74c55cf6123e64b3a6706caa032475793425ebba18c9ca60b3a35" +
+    "da91e6d7c4e998fc44aece8a6e0c47184176b4430378e12f1c970a7d27c6350d" +
+    "080d79a08b535fe89afb2e02e9d72bb652fb3c09ab948b3fcc43401f0e5719c5" +
+    "0cb859975770f0389430eed2c82883e3d07f727b4442f9922712ae763f9c32d4" +
+    "84ddd3c2d220ada8e70fef0d5217d24df24f000b827d84ce26702a253717e9bc" +
+    "3aaddd3de3ccd833adf668efca3ae6db77290b5de6d6ee5c8223a500066ca69f" +
+    "3694ba6b1c15414a7c689f284bad5402d01aa3738196b653c6795e512d839e10" +
+    "9f99210803fbc635dd0dcf19c1ea141c8772fb43ea18606f7cae68974b23ff03" +
+    "90f0f76cde8e23c19844d95e9564c3174572c45654c2e9e727839b768057993f" +
+    "6348c81e45be01e6b8b41cd2156aa05e5587c5fe7c54eb4803ddaa82c717d6d6" +
+    "b7874dc209c0e3897ad3760a80af234a2d256e7d4fc120f92a3d9460e933b3ac" +
+    "99059edca183cc0e9226d128a799db259f6b0842a7c4d6c80d9b7dce202d33f9" +
+    "40fdecc27ffa9201dd2dc18043cae5c4460c0421c272b1b941543a80f7cd2aab" +
+    "edf9886c8fdd1ee85aa2ebb158046420fb44a7a0879f5a318a5434de86d58683" +
+    "898240d4c9e81b3ae28907472f8bc498ebce1266b6e721f3538d7f4737a8913d" +
+    "e29d9f4200dcfa988b3d17fefc4e24d33677f49842955abf06e80cc98ff255e0" +
+    "a23db1556b6e9eea66bf121e8152d4ae73f674698cf09d7ee7b7863f9fd00d81" +
+    "2f144ef1237ab6a4f2f6c9a69c0129f231df17ff5815a8871ef7fe16fc8efd1a"
+  ].pack('H*')
+
+  ## Expected plaintext result as ASCII-8BIT binary string (though
+  ## it technically does contain several two-byte UTF-8 Unicode
+  ## endash characters mixed in):
   PLAINTEXT = 
-    "This is a PLAINTEXT file for testing\n"
+    "Four score and seven years ago our fathers brought forth on this "   +
+    "continent a new nation, conceived in liberty, and dedicated to the " +
+    "proposition that all men are created equal.\n"                       +
+    "Now we are engaged in a great civil war, testing whether that "      +
+    "nation, or any nation so conceived and so dedicated, can long "      +
+    "endure. We are met on a great battlefield of that war. We have "     +
+    "come to dedicate a portion of that field, as a final resting place " +
+    "for those who here gave their lives that that nation might live. "   +
+    "It is altogether fitting and proper that we should do this.\n"       +
+    "But, in a larger sense, we can not dedicate, we can not "            +
+    "consecrate, we can not hallow this ground. The brave men, living "   +
+    "and dead, who struggled here, have consecrated it, far above our "   +
+    "poor power to add or detract. The world will little note, nor long " +
+    "remember what we say here, but it can never forget what they did "   +
+    "here. It is for us the living, rather, to be dedicated here to the " +
+    "unfinished work which they who fought here have thus far so nobly "  +
+    "advanced. It is rather for us to be here dedicated to the great "    +
+    "task remaining before us" + ENDASH + "that from these honored dead " +
+    "we take increased devotion to that cause for which they gave the "   +
+    "last full measure of devotion" + ENDASH + "that we here highly "     +
+    "resolve that these dead shall not have died in vain" + ENDASH        +
+    "that this nation, under God, shall have a new birth of freedom"      +
+    ENDASH + "and that government of the people, by the people, for the " +
+    "people, shall not perish from the earth.\n"
+
+  ## Passphrase used to decrypt:
   PASS      =
-    "topsecretstuff"
+    "gfDLT0RbXgW5OvLnoj7mEX (Now doesn't that look fun...)"
 
   def setup
     ## Create a temporary file:
@@ -36,7 +113,7 @@ class FileSafeDecryptTest < Test::Unit::TestCase
     ## Read decrypted file contents:
     plaintext = File.open(@testfile,'r'){|f| f.read}
 
-    assert(PLAINTEXT == plaintext)
+    assert(PLAINTEXT == plaintext, "Decryption of ciphertext with passphrase failed to match expected plaintext result.")
   end
 end
 

data/test/test_encrypt.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+# encoding: ASCII-8BIT
+
+require 'test/unit'
+require_relative '../lib/filesafe.rb'
+
+class FileSafeEncryptTest < Test::Unit::TestCase
+  PLAINTEXT = [
+    "eb82c419f0bec066419fd1dd2d18fbe540ee9419f0e16dbb643effc0cb108f98" +
+    "be67cd67bce8745c6ad6259421093606186023b6ff86a684b086321822247489" +
+    "a264f20ea51c87ec72105f230a5f79520fe090b17c70e6e1df2ab0a0f28140eb" +
+    "7481399d4a327ceb5d7763d9f4df4810a8da896fc5e0ca068402359dc24272fe" +
+    "4fa12cd9d40a9f9b39e59c4d598f1db2f18e6932d34908a3a8591c818b146f64" +
+    "c37bc4d67610678dfa801502ca84d21e3eab03d9cfd862dc04e7f31aaee78d5d" +
+    "24b7ab09971f489ac9e16215f30e2b586e861ac39ffa34d656f084c29d5df1e9" +
+    "c22612b1fa1bfb955c745af3d64036e38c526ab20a37400122dac284f4ddbbd1" +
+    "ec706229c49422e6ab3ccc8a1766ab13cb876c2cca998aa46afa5e0433b21d2b" +
+    "9b5d4b3770aac592d19c5ff21202dc5d27e12b794ad5df26f97ab2c19a16f5ee" +
+    "2c21c90f8e462e43917cd109118d2cbc888dc6d29727cdba22857549b1900754" +
+    "b22e71d27df5a57b85da7e13ed6acb4768969491473d13c9298f980b08ba032e"
+  ].pack('H*')
+
+  DEBUG_PARAMS = [
+    ## SALT (48 bytes, 384 bits):
+    "4e7953c3f5434aabbb358af82363592ddbf42f707f6cfaf9" + 
+    "d61710b0cc7275829f6195881712baf29362cd7f73523de3" +
+    ## KEY (32 bytes, 256 bits):
+    "16cdd98ca1eacffd7685ab387ad882b603c93c4a26e5bf874747b15e122acd76" +
+    ## IV (16 bytes, 128 bits):
+    "1a2466b2480b84d571b1749e9bab67f5"
+  ].pack('H*')
+
+  CIPHERTEXT = [
+    ## SALT (48 bytes, 384 bits):
+    "4e7953c3f5434aabbb358af82363592ddbf42f707f6cfaf9" +
+    "d61710b0cc7275829f6195881712baf29362cd7f73523de3" +
+    ## C_F_KEY (32 bytes, 256 bits):
+    "d83eab0e69e061212206f8a8a24e83150370eebbb4458464f8c3d929b922c35e" +
+    ## C_F_IV (16 bytes, 128 bits):
+    "51a8cf9549d3dcb1d83d504d31d160a1" +
+    ## PBKDF2(passphrase + HMAC(SALT + C_F_KEY + C_F_IV)) (512 bits, 64 bytes):
+    "b1e619b7cdae804fb127440458852f2955fb3d0a5a2121c93ea03427f7f1d029" +
+    "ae88b0b3acc2b05d2dcc0af79934282e469024e8a9cd8f9f5671afaa6290784f" +
+    ## CIPHERTEXT BLOCKS:
+    "7852374484758b04bcf661a667dc2e03576f231897a52426f9cd547667b6ef16" +
+    "bcf17d2f23e9a30115a1619a219158259e64d13d3197019af92a8ccb22d24e0e" +
+    "248d48f867223086eb5ec729878fbe1696d83f357791c2af221ba7843cbb149c" +
+    "9ca1e50816dd14ccff97cf37e554d87b8ee3a4d121025877554858e3d365ab6a" +
+    "0440e65bf191d51f58eb3cee355101ab507dedb1700cb668843f698a4e8539d2" +
+    "324416336d479b156232d9759719596fe8d8ef494a33e7859d349a8764866b43" +
+    "0395d4f88234fcec7d9972ded3ec7418bcf098f0004245d3733ed80c7a2e6a5f" +
+    "ada107b1b7cc770bf9063e5f86de817c3fb72c2b8c3354c85c1c32770fb81052" +
+    "f2aab51e76233b755ba7712fb1389c267d994ded420c30fed22834cf5d0b1924" +
+    "9c5a297e5f57e5b9a7f2318b6edccf9a1d2b024cc6c4e7d8bbf3435185c8f7e0" +
+    "caa97abc688873da904deadc744c216ef044901edce3d239ffffc4b4f999a3cc" +
+    "32671bd83819b0478638eef85b5063bd5ba2cf9bc1f57ad05afc44fe35ff546f" +
+    "563b163ddb641c2e8f9bcd603b7d5c12"
+  ].pack('H*')
+  PASS      =
+    "This is my very TOP SECRET passphrase.  Please don't share it!"
+
+  def setup
+    ## Create a temporary file:
+    @testfile = 'test.out'
+    File.open(@testfile,'w'){|f| f.print PLAINTEXT}
+  end
+
+  def teardown
+    File.unlink(@testfile)
+  end
+
+  def test_encrypt
+    ## Encrypt data:
+    FileSafe.encrypt(@testfile, PASS, true, DEBUG_PARAMS)
+
+    ## Read encrypted file contents:
+    ciphertext = File.read(@testfile, :encoding => Encoding::BINARY)
+
+    assert(CIPHERTEXT == ciphertext, "Resulting encryption of plaintext to ciphertext does NOT match expected ciphertext.")
+  end
+end
+

metadata

@@ -1,38 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: filesafe
 version: !ruby/object:Gem::Version
-  version: 3.0.0
-  prerelease: 
+  version: 3.1.0
 platform: ruby
 authors:
 - Aaron D. Gifford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-29 00:00:00.000000000Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pbkdf2
-  requirement: &17188861760 !ruby/object:Gem::Requirement
-    none: false
+  name: pbkdf2-ruby
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *17188861760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &17188861060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *17188861060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 description: A utility script for encrypting and decrypting files using a randomly
   generated 256-bit AES key and initialization vector secured using the PBKDF2 password/passphrase
   key derivation algorithm to secure the file key and IV.
@@ -44,36 +61,37 @@ extra_rdoc_files:
 - README.txt
 files:
 - README.txt
-- VERSION.txt
 - Rakefile
+- VERSION.txt
 - bin/filesafe
 - lib/filesafe.rb
-- test/test_module.rb
-- test/test_decrypt.rb
 - test/test_cli.rb
+- test/test_decrypt.rb
+- test/test_encrypt.rb
+- test/test_module.rb
 homepage: http://www.aarongifford.com/computers/filesafe/
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Encrypt/decrypt files with a random 256-bit AES key secured by a passphrase
   derived master key using PBKDF2
 test_files: []