scrypt 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47be4799daf5f3fd84b4d621688dea4c39ccde5b
-  data.tar.gz: 5bf369b0264bf440229eee7fa05e65227357da68
+  metadata.gz: e05230df281722bf8d1b9814cc6220d1bb233969
+  data.tar.gz: 86546aa3292d6cc0a090f7d8bf38f11688fa105d
 SHA512:
-  metadata.gz: c17413705aeef9517208e2bf83545fa488aa6b8fade35728cbcdf1e4b3f91a513d756db9ae81b4041e69c30c6c21b22484dff1c2530167f0de4e382612986bde
-  data.tar.gz: 2ccfe62cebda01b2d23a91af9e65cc9b2f64b755c6e602b7612fa43a5448959db9a2ae5b6b2d4529e6e5e5c8a7132830e850c47d85d694d41a24f8d91d73ff93
+  metadata.gz: 78116f0fade1bd7389283b1ae897098cb87a10664ac5ddf06adc58be7546f6a71c49e0c962a55f923594584946b8d746653a69a5c1042699ac4c8c84f4d649db
+  data.tar.gz: 39f52693cdcbf061be0dffc17d26d33e8f63cf5121300369aaaf05f884e9ad96cef29e2098fc7fd85b0f06edbd0704121139a599a8b2cbc8f4d0d2f4c7b7ccbf

data/README.md

@@ -41,6 +41,7 @@ Password.create takes five options which will determine the key length and salt
 * `:max_time` specifies the maximum number of seconds the computation should take.
 * `:max_mem` specifies the maximum number of bytes the computation should take. A value of 0 specifies no upper limit. The minimum is always 1 MB.
 * `:max_memfrac` specifies the maximum memory in a fraction of available resources to use. Any value equal to 0 or greater than 0.5 will result in 0.5 being used.
+* `:cost` specifies a cost string (e.g. `'400$8$19$'`) from the `calibrate` method.  The `:max_*` options will be ignored if this option is given, or if `calibrate!` has been called.
 
 Default options will result in calculation time of approx. 200 ms with 1 MB memory use.
 
@@ -57,6 +58,12 @@ salt = SCrypt::Engine.generate_salt
 
 SCrypt::Engine.hash_secret "my grand secret", salt
 # => "400$8$26$b62e0f787a5fc373$0399ccd4fa26642d92741b17c366b7f6bd12ccea5214987af445d2bed97bc6a2"
+
+SCrypt::Engine.calibrate!(max_mem: 16 * 1024 * 1024)
+# => "4000$8$4$"
+
+SCrypt::Engine.generate_salt
+# => "4000$8$4$c6d101522d3cb045"
 ```
 
 ## Usage in Rails (and the like)

data/lib/scrypt.rb

@@ -26,7 +26,8 @@ module SCrypt
       :salt_size   => 8,
       :max_mem     => 1024 * 1024,
       :max_memfrac => 0.5,
-      :max_time    => 0.2
+      :max_time    => 0.2,
+      :cost        => nil
     }
 
     def self.scrypt(secret, salt, *args)
@@ -67,10 +68,14 @@ module SCrypt
       end
     end
 
-    # Generates a random salt with a given computational cost.
+    # Generates a random salt with a given computational cost.  Uses a saved
+    # cost if SCrypt::Engine.calibrate! has been called.
+    #
+    # Options:
+    # <tt>:cost</tt> is a cost string returned by SCrypt::Engine.calibrate
     def self.generate_salt(options = {})
       options = DEFAULTS.merge(options)
-      cost = calibrate(options)
+      cost = options[:cost] || calibrate(options)
       salt = OpenSSL::Random.random_bytes(options[:salt_size]).unpack('H*').first.rjust(16,'0')
       if salt.length == 40
         #If salt is 40 characters, the regexp will think that it is an old-style hash, so add a '0'.
@@ -110,6 +115,12 @@ module SCrypt
       options = DEFAULTS.merge(options)
       "%x$%x$%x$" % __sc_calibrate(options[:max_mem], options[:max_memfrac], options[:max_time])
     end
+    
+    # Calls SCrypt::Engine.calibrate and saves the cost string for future calls to
+    # SCrypt::Engine.generate_salt.
+    def self.calibrate!(options = {})
+      DEFAULTS[:cost] = calibrate(options)
+    end
 
     # Computes the memory use of the given +cost+
     def self.memory_use(cost)

data/lib/scrypt/version.rb

@@ -1,3 +1,3 @@
 module SCrypt
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/scrypt/engine_spec.rb

@@ -16,6 +16,15 @@ describe "Generating SCrypt salts" do
   it "should produce random data" do
     SCrypt::Engine.generate_salt.should_not equal(SCrypt::Engine.generate_salt)
   end
+
+  it "should used the saved cost factor" do
+    # Verify cost is different before saving
+    cost = SCrypt::Engine.calibrate(:max_time => 0.01)
+    SCrypt::Engine.generate_salt(:max_time => 30, :max_mem => 64*1024*1024).should_not start_with(cost)
+
+    cost = SCrypt::Engine.calibrate!(:max_time => 0.01)
+    SCrypt::Engine.generate_salt(:max_time => 30, :max_mem => 64*1024*1024).should start_with(cost)
+  end
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrypt
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Patrick Hogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-24 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-compiler
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: scrypt
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: scrypt password hashing algorithm.