multi_password 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bedf3cb4f2713cd269dc2299186bfc4b9da288d336a59e20d0e6c11fc467541
-  data.tar.gz: c69c01925c5588d2d95ec94984977304655e1090b9e6c1e8040c2f41df15943b
+  metadata.gz: 153b813e37bf5c0c015e3ceed5b169ef4d6c8fb9230b7343d0435b6ba246d33a
+  data.tar.gz: 83614237a55c98420d9ee025df0d5ddfa1b9f4d9ecd72aeb7cfd3826e40a4fa9
 SHA512:
-  metadata.gz: 5033e7251658eb78f0925e65fcb93103d2d110cbc3df3513ecf4e5a0f8b489162d3834c5f1956dac2403a9e084f2e3dc21409798f7bd807b44a8264fce0656ed
-  data.tar.gz: 6c0d5089fa54596cfe0d531fcd3d38c33fff7b5756edd6bad13c66a85920bab3e0b89e3f7cb3202780e079142bebd9cc5cf376785f1fdf6efb4de0ed719a1035
+  metadata.gz: 87572ff497e9018fac1f56428a52bd6cdfce9b5c9fb6f7717d095e29c54997f45ec8dcc42da8372f140536db0abe80a761588f882e138d32e16507380f8d663a
+  data.tar.gz: 1a02471f7dcbb7486262cc173c99fdec3aba716ccc3f6ea6e48e556bfe548216251d7171aea4cdf3a1a5c3c879e4f1017dcef529ff52f80839d4f46ab68932b8

data/CHANGELOG

@@ -0,0 +1,7 @@
+# 0.1.1
+
+- Validate cost options for all algorithms
+
+# 0.1.0
+
+- Initial release

data/README.md

@@ -56,6 +56,9 @@ You can also specify algorithm and options on-the-fly:
 manager = MultiPassword.new(algorithm: :scrypt, options: { key_len: 64, max_time: 1 })
 ```
 
+**NOTE**: `MultiPassword` helps you validate the options when initializing the
+instance and configuration.
+
 ### Interface
 
 MultiPassword provides 2 methods: `create` for hashing password and `verify` for

data/lib/multi_password.rb

@@ -31,9 +31,15 @@ class MultiPassword
     registers.delete(algorithm)
   end
 
+  def self.configure(&block)
+    super.tap do
+      new(algorithm: config.default_algorithm, options: config.default_options)
+    end
+  end
+
   def initialize(algorithm: config.default_algorithm, options: config.default_options)
     @strategy = registers.fetch(algorithm).new
-    @options = options
+    @options = @strategy.validate_options(options)
   rescue KeyError
     raise AlgorithmNotRegistered.new(algorithm)
   end

data/lib/multi_password/errors.rb

@@ -12,4 +12,10 @@ class MultiPassword
       super("Algorithm #{algorithm} is not registered. Try requiring 'multi_password/strategies/#{algorithm}'.")
     end
   end
+
+  class InvalidOptions < Error
+    def initialize(strategy, message)
+      super("Algorithm #{strategy} options: #{message}")
+    end
+  end
 end

data/lib/multi_password/strategies/argon2.rb

@@ -9,12 +9,29 @@ class MultiPassword
       register :argon2
 
       def create(password, options = {})
-        ::Argon2::Password.new(options).create(password)
+        ::Argon2::Password.new(validate_options(options)).create(password)
       end
 
       def verify(password, encrypted_password)
         ::Argon2::Password.verify_password(password, encrypted_password)
       end
+
+      def validate_options(options)
+        return options if options.empty?
+
+        t_cost = options[:t_cost]
+        m_cost = options[:m_cost]
+
+        if t_cost && (!t_cost.is_a?(Integer) || t_cost < 1 || t_cost > 750)
+          raise InvalidOptions.new('argon2', 't_cost must be an integer between 1 and 750')
+        end
+
+        if m_cost && (!m_cost.is_a?(Integer) || m_cost < 1 || m_cost > 31)
+          raise InvalidOptions.new('argon2', 'm_cost must be an integer between 1 and 31')
+        end
+
+        options
+      end
     end
   end
 end

data/lib/multi_password/strategies/bcrypt.rb

@@ -9,12 +9,24 @@ class MultiPassword
       register :bcrypt
 
       def create(password, options = {})
-        ::BCrypt::Password.create(password, options).to_s
+        ::BCrypt::Password.create(password, validate_options(options)).to_s
       end
 
       def verify(password, encrypted_password)
         ::BCrypt::Password.new(encrypted_password) == password
       end
+
+      def validate_options(options)
+        return options if options.empty?
+
+        cost = options[:cost]
+
+        if !cost.is_a?(Integer) || cost < 4 || cost > 31
+          raise InvalidOptions.new('bcrypt', 'cost must be an integer between 4 and 31')
+        end
+
+        options
+      end
     end
   end
 end

data/lib/multi_password/strategies/scrypt.rb

@@ -9,12 +9,34 @@ class MultiPassword
       register :scrypt
 
       def create(password, options = {})
-        ::SCrypt::Password.create(password, options).to_s
+        ::SCrypt::Password.create(password, validate_options(options)).to_s
       end
 
       def verify(password, encrypted_password)
         ::SCrypt::Password.new(encrypted_password) == password
       end
+
+      def validate_options(options)
+        return options if options.empty?
+
+        key_len = options[:key_len]
+        max_time = options[:max_time]
+        max_mem = options[:max_mem]
+
+        if key_len && (!key_len.is_a?(Integer) || key_len < 16 || key_len > 512)
+          raise InvalidOptions.new('scrypt', 'key_len must be an integer between 16 and 512')
+        end
+
+        if max_time && (!max_time.is_a?(Integer) || max_time < 0 || max_time > 2)
+          raise InvalidOptions.new('scrypt', 'max_time must be an integer between 0 and 2')
+        end
+
+        if max_mem && (!max_mem.is_a?(Numeric) || max_mem < 0 || max_mem > 256)
+          raise InvalidOptions.new('scrypt', 'max_mem must be a number between 0 and 256')
+        end
+
+        options
+      end
     end
   end
 end

data/lib/multi_password/strategy.rb

@@ -17,5 +17,9 @@ class MultiPassword
     def verify(_password, _encrypted_password)
       raise MethodNotImplemented, 'verify'
     end
+
+    def validate_options(_options)
+      raise MethodNotImplemented, 'validate_options'
+    end
   end
 end

data/lib/multi_password/version.rb

@@ -1,3 +1,3 @@
 class MultiPassword
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_password
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Hieu Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -49,7 +49,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4