scrypt-ruby 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b6d46b9b645c57061fb80d42fbea4b05574550c
+  data.tar.gz: 200ba6e9b43d9f7a04c78e60676922ca89e6ae5b
+SHA512:
+  metadata.gz: 456336fb58d7ad005a5557850bb562e4a83cbf5936b0276a24e1857e842b8a413ff4edf1aa80e2da65b051fc2149e80b57b1f54606790463c8d1f5411bcc706a
+  data.tar.gz: 6f428784c04c4c55e0ad18aefe013f14971b03942003ac476a6e46743ffad5e7a04d3599ad8f7a6771a5469e7e3dd282ffaa0bc97985ecd872ab2ff6314088c0

data/MIT-LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2016 Barry Allard barry (dot) allard (at) gmail (dot).com
+
+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/README.md

@@ -0,0 +1,61 @@
+# [scrypt-ruby](https://github.com/steakknife/scrypt-ruby)
+
+
+## Universal SCrypt adapter library
+
+
+### Usage
+
+```ruby
+require 'scrypt-ruby' # instead of require 'scrypt'
+```
+
+The API is basically the same as [https://github.com/pbhogan/scrypt](), so it's a drop-in replacement for scrypt on JRuby or regular Rubies
+
+
+### Installation
+#### Gem
+```shell
+gem install scrypt-ruby
+```
+
+#### Bundler
+```ruby
+# Gemfile
+gem 'scrypt-ruby'
+```
+
+### Supported Platforms
+#### JRuby 
+- FreeBSD
+- Linux
+- Mac OS X
+- Windows (uncertain/untested)
+
+Support provided by [https://github.com/wg/scrypt]()
+
+#### MRI / CRuby / Rubinius
+- FreeBSD
+- Linux
+- Mac OS X 
+- Windows
+
+Support provided by [https://github.com/pbhogan/scrypt]()
+
+#### Patches
+
+PR's welcome!
+
+For bonus points, use feature branches in your head fork to keep things clearer.
+
+#### Issues
+
+[Issue tracker](https://github.com/steakknife/scrypt-ruby/issues)
+
+#### License
+
+[MIT License](MIT-LICENSE.txt)
+
+#### Copyright
+
+Copyright (C) 2016 Barry Allard

data/gem-public_cert.pem

@@ -0,0 +1,32 @@
+-----BEGIN CERTIFICATE-----
+MIIFgDCCA2igAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRUwEwYDVQQDDAxiYXJy
+eS5hbGxhcmQxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+A2NvbTAeFw0xNjAxMDkxMDE3MTJaFw0xNzAxMDgxMDE3MTJaMEMxFTATBgNVBAMM
+DGJhcnJ5LmFsbGFyZDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+LGQBGRYDY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0xJH/kux
+PRBS4y2r4YM+dtEfTOECrEw6JHpQOszJAT8FvJ5cTdPNpUtHGFYUruYRA+qHGM4a
+If/YX7X17W77PvzqFalb1wicroRVDEgbyQWYkLVUL/vKugf7U3YknWhbBxkph23k
+xGG6PO9nMKLk16rPaU6stJJvUjL4Yi7JUSwFWNrgx/t6O/iNzq5kcVR7F+NeCt+W
+sWiXQGm6uZ6OJH0jpK2F1ic5/CWhPWKh+DKngZhN2As6H/m+ea9cm1Emcg+T/oDM
+8T980i0MvZXrQ1wXoipVAjqmM4/dlqcy3nBxxG2IUg1zQrd30VzwNC2Rb0VovYJ9
+OHyiYi1X4KQlIwpJ0STzRAfy231ZulDTST9KiOkprIz/ERAPv3OiiN6P6Cyz/Bus
+9VjlaPn3maMiIQq9H6UK4cwA587esoBLT8uHrCc+qOfc8JGbfzzwe86BAVPvZ9gJ
+B/gk+gXbEH84nsZLYT5iTNCrZjzeXb+OhK3OE9t4oEm/U0laN58/orVWDxx8xYT1
+9Pdf0716KexmdvwgouKsrog8aWvfIaj2uNEbLTX/hKWRF3rENtYT8/h3KBraIiro
+vhphbyJaiEMV3RrKSyDMT0TIZT8sWLPpx+EyTlsYTjUH1x1UOZCn8JwyXA5smLcb
+QV3nmKeFP+05dM0827Rs0aHUyPDGb35p3p8CAwEAAaN/MH0wCQYDVR0TBAIwADAL
+BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFM/lqcZWJ4qeWFRhpoaKdEFkd6gjMCEGA1Ud
+EQQaMBiBFmJhcnJ5LmFsbGFyZEBnbWFpbC5jb20wIQYDVR0SBBowGIEWYmFycnku
+YWxsYXJkQGdtYWlsLmNvbTANBgkqhkiG9w0BAQUFAAOCAgEAwBzluj18RhXSz1ea
+yLze39oqspy6boXVyDDmr1xkNezP5A7bm/u+/WlhL5xpJZzXJv8K1RrkSHf2VdFR
+hHIaelFwuSEuKHjhL0mFyp4uswlVlc4ZRVjDFW7uFe4LnM/P5StJBtXkeiDPs3O5
+AXaVsvIA3uyubHToSf2eN6RZajDEdHFU9ww0aS7GLzfPajWOMdvumsHt4ftHAIpH
+0l0rloTLk4r1EKGOytzqgQPArBFcsa2lnMV+iG/aVHnIbxc1rbXDHZbE3EghC2yz
+Eaeoj/f8a4zYJ4FmqHc+Ay6RO0XgqcMy1uib+MW/uOYdCSUClmhfFSwiUqj6ncsC
+UqF3y9sr7X7s84Q0JM/rPpkIkRG21jjWhfIBgnH+D5vzlJxdaJpsfuuMx6A1FvxR
+aAQ5nAcQhKJzNZuyAeq9lXv9CZOpjBUQdEiIAjoInIRwoi6fWJEx5dDlYyQ9Kp30
+HZi6DH/HlxTTuPJL6S10KaM/twTVGsNtBvdIBdDksWXkNVQ9no6PSIRS3VNTzG72
+uXxamIDMHelQyBERlaxyDC8pGHWq//wXvg2yG3Z+ZqvpUXaZTiRS7ZQ3zj2yvdqB
+b4WKJs00+KO3etYQG7qD/wH7WEwu3QoLNapYz58Jc0OsDnwBWW0IDPSAFsENoTcY
+8m+dgfPonsYSqnDDfLuAmtKhLAA=
+-----END CERTIFICATE-----

data/lib/scrypt-ruby.rb

@@ -0,0 +1,231 @@
+if RUBY_ENGINE == 'jruby'
+  autoload :Benchmark, 'benchmark'
+  autoload :Digest, 'digest'
+  autoload :OpenSSL, 'openssl'
+  require File.expand_path('../scrypt-1.4.0.jar', __FILE__)
+  module SCrypt
+    @@debug = false
+    def self.debug=(d)
+      @@debug = d
+    end
+
+    def self.debug(*args)
+      return @@debug if args.length == 0
+      $stderr.puts(*args) if @@debug
+    end
+
+    module Errors
+      class InvalidHash < StandardError; end
+      class InvalidSalt < StandardError; end
+      class InvalidSecret < StandardError; end
+    end
+
+    class Password < String
+      attr_reader :cost, :digest, :salt
+
+      def initialize(encrypted_password)
+        encrypted_password = encrypted_password.to_s
+        raise Errors::InvalidHash, "invalid hash" unless valid_hash? encrypted_password
+        @cost, @salt, @digest = split_hash(replace(encrypted_password))
+      end
+
+      def self.create(plaintext_password, options = {})
+        options = Engine::DEFAULTS.merge(options)
+        key_len = [[options.delete(:key_len), 16].max, 512].min
+        options[:salt_size] = [[options[:salt_size], 8].max, 32].min
+        salt = Engine.generate_salt(options)
+        hash = Engine.hash_secret(plaintext_password, salt, key_len)
+        new(hash)
+      end
+
+      def ==(plaintext_password)
+        self.class.secure_compare(self, Engine.hash_secret(plaintext_password, @cost + @salt, self.digest.length / 2))
+      end
+
+      alias :is_password? :==
+
+    private
+      def self.secure_compare(x, y)
+       x.bytesize == y.bytesize && x.bytes.zip(y.bytes).inject(0) { |res, b| res |= b.inject(:^) } == 0
+      end
+
+      def split_hash(h)
+        n, v, r, salt, hash = h.to_s.split('$')
+       [[n, v, r].join('$') + "$", salt, hash]
+      end
+
+      def valid_hash?(h)
+        !!h.match(/^[0-9a-z]+\$[0-9a-z]+\$[0-9a-z]+\$[A-Za-z0-9]{16,64}\$[A-Za-z0-9]{32,1024}$/)
+      end 
+    end # Password
+
+    class Engine
+      DEFAULTS = {
+        key_len: 32,
+        salt_size: 32,
+        max_mem: 16 * 1024 * 1024, # 16 MiB
+        max_memfrac: 0.5,
+        max_time: 0.2,
+        cost: nil
+      }
+      
+      # @param plaintext_password String
+      # @param salt String
+      # @param args [String, key_len] or [n, r, p, key_len]
+      def self.scrypt(plaintext_password, salt, *args)
+        key_len = args.last
+        n = r = p = nil
+        case args.length
+        when 2
+          n, r, p = args[0].split('$').map{ |x| x.to_i(16) }
+        when 4
+          n, r, p = args
+        else
+          raise ArgumentError, 'only 4 or 6 arguments allowed'
+        end
+        raw_encrypted_password = com.lambdaworks.crypto.SCrypt.scrypt(plaintext_password.to_s.to_java_bytes, salt.to_java_bytes, n, r, p, key_len)
+        String.from_java_bytes raw_encrypted_password
+      end
+
+      # "4000$8$4$c6d101522d3cb045"
+      def self.generate_salt(options = {})
+        options = DEFAULTS.merge(options)
+        cost = options[:cost] || calibrate(options)
+        salt_size = options.delete :salt_size
+        salt = OpenSSL::Random.random_bytes(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'.
+          salt = '0' + salt
+        end
+        cost + salt
+      end
+
+      #   N   r p
+      # "4000$8$4$"
+      def self.calibrate!(options = {})
+        DEFAULTS[:cost] = calibrate(options)
+      end
+
+      def self.debug(*args)
+        SCrypt.debug(*args)
+      end
+
+      #   N  r p
+      # "400$8$25$"
+      def self.calibrate(options = {})
+        options = DEFAULTS.merge(options)
+        max_mem = options.delete :max_mem
+        max_memfrac = options.delete :max_memfrac
+        max_time = options.delete :max_time
+
+        mem_limit = memtouse(max_mem, max_memfrac)
+        ops_limit = [cpuperf * max_time, 32768].min
+        debug "ops_limit #{ops_limit} ops"
+
+        n, r, p = nil, 8, nil
+
+        if ops_limit < mem_limit/32
+          debug "pick based on CPU limit"
+          # Set p = 1 and choose N based on the CPU limit. 
+          p = 1
+          max_n = ops_limit / (r * 4)
+          n = 1 << (1...63).find { |i| (1 << i) > max_n / 2 }
+	      else
+          debug "pick based on memory limit"
+          # Set N based on the memory limit. */
+      		max_n = mem_limit / (r * 128)
+          n = 1 << (1..63).find { |i| (1 << i) > max_n / 2 }
+
+          # Choose p based on the CPU limit. */
+          max_rp = [(ops_limit / 4) / (1 << n), 0x3fffffff].min
+          p = max_rp / r
+        end
+        debug "calibrated using: N #{n} r #{r} p #{p}"
+        "#{n.to_s(16)}$#{r.to_s(16)}$#{p.to_s(16)}$"
+      end
+
+      # @returns Boolean
+      def self.valid_cost?(cost)
+        !!cost.match(/^[0-9a-z]+\$[0-9a-z]+\$[0-9a-z]+\$$/)
+      end
+
+      # @returns Boolean
+      def self.valid_salt?(salt)
+        !!salt.match(/^[0-9a-z]+\$[0-9a-z]+\$[0-9a-z]+\$[A-Za-z0-9]{16,64}$/)
+      end
+
+      # @returns Boolean
+      def self.valid_secret?(secret)
+        secret.respond_to?(:to_s)
+      end
+
+      def self.hash_secret_old(secret, salt, cost)
+        salt + "$" + Digest::SHA1.hexdigest(scrypt(secret.to_s, salt, cost, 256))
+      end
+
+      def self.hash_secret_new(secret, salt_only, cost, key_len)
+        salt_only = [salt_only.sub(/^(00)+/, '')].pack('H*')
+        scrypt(secret.to_s, salt_only, cost, key_len).unpack('H*').first.rjust(key_len * 2, '0')
+      end
+
+      # "400$8$26$b62e0f787a5fc373$0399ccd4fa26642d92741b17c366b7f6bd12ccea5214987af445d2bed97bc6a2"
+      def self.hash_secret(secret, salt, key_len = DEFAULTS[:key_len])
+        raise Errors::InvalidSalt, "invalid salt" unless valid_salt? salt
+        raise Errors::InvalidSecret, "invalid secret" unless valid_secret? secret
+
+         cost = cost_from_salt(salt)
+         salt_only = salt_only(salt)
+
+         if salt_only.length == 40
+           hash_secret_old(secret, salt, cost)
+         else
+           salt + "$" + hash_secret_new(secret, salt_only, cost, key_len)
+         end
+      end
+
+      private
+
+      def self.cost_from_salt(salt)
+        salt[/^[0-9a-z]+\$[0-9a-z]+\$[0-9a-z]+\$/]
+      end
+
+      def self.salt_only(salt)
+        salt[/\$([A-Za-z0-9]{16,64})$/, 1]
+      end
+
+      # Estimate how many scrypts / second
+      def self.cpuperf
+        iterations = 1000
+        empty_array = "".to_java_bytes.freeze
+        run = -> { iterations.times { com.lambdaworks.crypto.SCrypt.scrypt(empty_array, empty_array, 128, 1, 1, 1) } }
+        # warm-up
+        run.()
+        loop do 
+          time = Benchmark.realtime { |x| run.() }
+          if time > 0.33
+            per_sec = iterations/time
+            debug "cpuperf #{per_sec} ops/s"
+            return per_sec
+          end
+          iterations *= 10
+        end
+      end
+
+      # 
+      def self.memtouse(max_mem, max_memfrac)
+        max_memfrac = 0.5 if max_memfrac > 0.5 || max_memfrac == 0
+
+        memlimit_min = java.lang.Runtime.getRuntime.freeMemory
+        debug "free mem #{memlimit_min / 1048576} MiB"
+
+      	mem_avail = max_memfrac * memlimit_min
+        mem_avail = [mem_avail, max_mem].min if max_mem > 0
+        mem_avail = [mem_avail, 1024*1024].max
+        debug "memtouse #{mem_avail / 1048576} MiB"
+        mem_avail
+      end
+    end # Engine
+  end # SCrypt
+else
+  require 'scrypt'
+end

data/scrypt-ruby.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification::new do |s|
+  s.name = 'scrypt-ruby'
+  s.version = '2.0.0'
+  s.summary = 'Universal SCrypt adapter'
+  s.description = 'Universal SCrypt PBKDF adapter (for CRuby (MRI) and JRuby)'
+  s.license = 'MIT'
+
+  s.files = [
+    'README.md',
+    'MIT-LICENSE.txt',
+    'gem-public_cert.pem',
+    'scrypt-ruby.gemspec',
+    'lib/scrypt-1.4.0.jar',
+    'lib/scrypt-ruby.rb',
+  ]
+
+  s.required_ruby_version = '>= 1.9.3'
+  s.require_path = 'lib'
+  s.author = 'Barry Allard'
+  s.email = 'barry.allard@gmail.com'
+  s.homepage = 'https://github.com/steakknife/scrypt-ruby'
+
+  if RUBY_PLATFORM == 'java'
+    s.platform = 'java'
+  else
+    s.add_dependency 'scrypt', '~> 2.0'
+  end
+end
+.tap {|gem| pk = File.expand_path(File.join('~/.keys', 'gem-private_key.pem')); gem.signing_key = pk if File.exist? pk; gem.cert_chain = ['gem-public_cert.pem']} # pressed firmly by waxseal

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: scrypt-ruby
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Barry Allard
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIFgDCCA2igAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRUwEwYDVQQDDAxiYXJy
+  eS5hbGxhcmQxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0xNjAxMDkxMDE3MTJaFw0xNzAxMDgxMDE3MTJaMEMxFTATBgNVBAMM
+  DGJhcnJ5LmFsbGFyZDEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA0xJH/kux
+  PRBS4y2r4YM+dtEfTOECrEw6JHpQOszJAT8FvJ5cTdPNpUtHGFYUruYRA+qHGM4a
+  If/YX7X17W77PvzqFalb1wicroRVDEgbyQWYkLVUL/vKugf7U3YknWhbBxkph23k
+  xGG6PO9nMKLk16rPaU6stJJvUjL4Yi7JUSwFWNrgx/t6O/iNzq5kcVR7F+NeCt+W
+  sWiXQGm6uZ6OJH0jpK2F1ic5/CWhPWKh+DKngZhN2As6H/m+ea9cm1Emcg+T/oDM
+  8T980i0MvZXrQ1wXoipVAjqmM4/dlqcy3nBxxG2IUg1zQrd30VzwNC2Rb0VovYJ9
+  OHyiYi1X4KQlIwpJ0STzRAfy231ZulDTST9KiOkprIz/ERAPv3OiiN6P6Cyz/Bus
+  9VjlaPn3maMiIQq9H6UK4cwA587esoBLT8uHrCc+qOfc8JGbfzzwe86BAVPvZ9gJ
+  B/gk+gXbEH84nsZLYT5iTNCrZjzeXb+OhK3OE9t4oEm/U0laN58/orVWDxx8xYT1
+  9Pdf0716KexmdvwgouKsrog8aWvfIaj2uNEbLTX/hKWRF3rENtYT8/h3KBraIiro
+  vhphbyJaiEMV3RrKSyDMT0TIZT8sWLPpx+EyTlsYTjUH1x1UOZCn8JwyXA5smLcb
+  QV3nmKeFP+05dM0827Rs0aHUyPDGb35p3p8CAwEAAaN/MH0wCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFM/lqcZWJ4qeWFRhpoaKdEFkd6gjMCEGA1Ud
+  EQQaMBiBFmJhcnJ5LmFsbGFyZEBnbWFpbC5jb20wIQYDVR0SBBowGIEWYmFycnku
+  YWxsYXJkQGdtYWlsLmNvbTANBgkqhkiG9w0BAQUFAAOCAgEAwBzluj18RhXSz1ea
+  yLze39oqspy6boXVyDDmr1xkNezP5A7bm/u+/WlhL5xpJZzXJv8K1RrkSHf2VdFR
+  hHIaelFwuSEuKHjhL0mFyp4uswlVlc4ZRVjDFW7uFe4LnM/P5StJBtXkeiDPs3O5
+  AXaVsvIA3uyubHToSf2eN6RZajDEdHFU9ww0aS7GLzfPajWOMdvumsHt4ftHAIpH
+  0l0rloTLk4r1EKGOytzqgQPArBFcsa2lnMV+iG/aVHnIbxc1rbXDHZbE3EghC2yz
+  Eaeoj/f8a4zYJ4FmqHc+Ay6RO0XgqcMy1uib+MW/uOYdCSUClmhfFSwiUqj6ncsC
+  UqF3y9sr7X7s84Q0JM/rPpkIkRG21jjWhfIBgnH+D5vzlJxdaJpsfuuMx6A1FvxR
+  aAQ5nAcQhKJzNZuyAeq9lXv9CZOpjBUQdEiIAjoInIRwoi6fWJEx5dDlYyQ9Kp30
+  HZi6DH/HlxTTuPJL6S10KaM/twTVGsNtBvdIBdDksWXkNVQ9no6PSIRS3VNTzG72
+  uXxamIDMHelQyBERlaxyDC8pGHWq//wXvg2yG3Z+ZqvpUXaZTiRS7ZQ3zj2yvdqB
+  b4WKJs00+KO3etYQG7qD/wH7WEwu3QoLNapYz58Jc0OsDnwBWW0IDPSAFsENoTcY
+  8m+dgfPonsYSqnDDfLuAmtKhLAA=
+  -----END CERTIFICATE-----
+date: 2016-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Universal SCrypt PBKDF adapter (for CRuby (MRI) and JRuby)
+email: barry.allard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE.txt
+- README.md
+- gem-public_cert.pem
+- lib/scrypt-1.4.0.jar
+- lib/scrypt-ruby.rb
+- scrypt-ruby.gemspec
+homepage: https://github.com/steakknife/scrypt-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Universal SCrypt adapter
+test_files: []
+has_rdoc: