Rewrite all signatures.

Fixes #59, which is some new version of steep or something.

Author: technion

README.md

@@ -81,6 +81,9 @@ steep check
 ```
 These tools will need to be installed manually at this time and will be added to Gemfiles after much further testing.
 
+## Version 2.2.0
+This version changed the way the build system works to deal with a new version of Rubygems. See https://github.com/technion/ruby-argon2/issues/56.
+
 ## Version 2.0 - Argon 2id
 Version 2.x upwards will now default to the Argon2id hash format. This is consistent with current recommendations regarding Argon2 usage. It remains capable of verifying existing hashes.
 

sig/argon2.rbs

@@ -1,21 +1,41 @@
-# Classes
 module Argon2
+  # Front-end API for the Argon2 module.
   class Password
     @t_cost: Integer
     @m_cost: Integer
     @p_cost: Integer
     @salt: nil | String
     @secret: nil | String
+    @salt_do_not_supply: nil | String
+
+    # Expose constants for the options supported and default used for passwords.
+    DEFAULT_T_COST: 2
+
+    DEFAULT_M_COST: 16
+
+    DEFAULT_P_COST: 1
+
+    MIN_T_COST: 1
+
+    MAX_T_COST: 750
+
+    MIN_M_COST: 1
+
+    MAX_M_COST: 31
+
+    MIN_P_COST: 1
+
+    MAX_P_COST: 8
 
     def initialize: (?::Hash[untyped, untyped] options) -> void
+
     def create: (String pass) -> untyped
-    def self.create: (String pass) -> untyped
-    def self.valid_hash?: (string hash) -> Integer?
-    def self.verify_password: (untyped pass, untyped hash, ?nil secret) -> untyped
-  end
-  class Engine
-    def self.saltgen: () -> String
-  end
-  class ArgonHashFail < StandardError
+
+    # Helper class, just creates defaults and calls hash()
+    def self.create: (String pass, ?::Hash[untyped, untyped] options) -> String
+
+    def self.valid_hash?: (String hash) -> bool
+
+    def self.verify_password: (String pass, String hash, ?String|nil secret) -> bool
   end
 end

sig/engine.rbs

@@ -0,0 +1,9 @@
+module Argon2
+  # SecureRandom is a Ruby module. I have no idea why steep now thinks it's an unknown constant, nor why rbs
+  # prototype has no interest in outputting this.
+  SecureRandom: untyped
+  # Generates a random, binary string for use as a salt.
+  class Engine
+    def self.saltgen: () -> untyped
+  end
+end

sig/errors.rbs

@@ -0,0 +1,6 @@
+module Argon2
+  class ArgonHashFail < StandardError
+  end
+
+  ERRORS: ::Array["ARGON2_OK" | "ARGON2_OUTPUT_PTR_NULL" | "ARGON2_OUTPUT_TOO_SHORT" | "ARGON2_OUTPUT_TOO_LONG" | "ARGON2_PWD_TOO_SHORT" | "ARGON2_PWD_TOO_LONG" | "ARGON2_SALT_TOO_SHORT" | "ARGON2_SALT_TOO_LONG" | "ARGON2_AD_TOO_SHORT" | "ARGON2_AD_TOO_LONG" | "ARGON2_SECRET_TOO_SHORT" | "ARGON2_SECRET_TOO_LONG" | "ARGON2_TIME_TOO_SMALL" | "ARGON2_TIME_TOO_LARGE" | "ARGON2_MEMORY_TOO_LITTLE" | "ARGON2_MEMORY_TOO_MUCH" | "ARGON2_LANES_TOO_FEW" | "ARGON2_LANES_TOO_MANY" | "ARGON2_PWD_PTR_MISMATCH" | "ARGON2_SALT_PTR_MISMATCH" | "ARGON2_SECRET_PTR_MISMATCH" | "ARGON2_AD_PTR_MISMATCH" | "ARGON2_MEMORY_ALLOCATION_ERROR" | "ARGON2_FREE_MEMORY_CBK_NULL" | "ARGON2_ALLOCATE_MEMORY_CBK_NULL" | "ARGON2_INCORRECT_PARAMETER" | "ARGON2_INCORRECT_TYPE" | "ARGON2_OUT_PTR_MISMATCH" | "ARGON2_THREADS_TOO_FEW" | "ARGON2_THREADS_TOO_MANY" | "ARGON2_MISSING_ARGS" | "ARGON2_ENCODING_FAIL" | "ARGON2_DECODING_FAIL" | "ARGON2_THREAD_FAIL"]
+end

sig/ffi.rbs

@@ -1,8 +1,8 @@
 module Argon2
   # Direct external bindings. Call these methods via the Engine class to ensure points are dealt with
-  module Ext
-    extend FFI::Library
-  end
+#  module Ext
+#    extend FFI::Library
+#  end
 
   # The engine class shields users from the FFI interface.
   # It is generally not advised to directly use this class.

sig/hash_format.rbs

@@ -0,0 +1,31 @@
+module Argon2
+  #
+  # Get the values from an Argon2 compatible string.
+  #
+  class HashFormat
+    attr_reader variant: untyped
+
+    attr_reader version: untyped
+
+    attr_reader t_cost: untyped
+
+    attr_reader m_cost: untyped
+
+    attr_reader p_cost: untyped
+
+    attr_reader salt: untyped
+
+    attr_reader checksum: untyped
+
+    # FIXME: Reduce complexity/AbcSize
+    # rubocop:disable Metrics/AbcSize
+    def initialize: (untyped digest) -> void
+
+    #
+    # Checks whether a given digest is a valid Argon2 hash.
+    #
+    # Supports 1 and argon2id formats.
+    #
+    def self.valid_hash?: (untyped digest) -> untyped
+  end
+end