argon2id 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37869678ea2afe9b0cd0ae0aa40d74dc697413d1184782bb9cce45e09c1bcba0
-  data.tar.gz: '095f548a9967a7f228d03893530314731e18a1796a4eadc58fae1147f4450df5'
+  metadata.gz: c9cccf037023d8c6788dd8121b537ba8bcb2b4d1cb490fc335ea0f196246c351
+  data.tar.gz: 63080bd2c9934a105f6b43eae9b48ac0a913eecf00fd6bc3a6d9432708e6567a
 SHA512:
-  metadata.gz: 0ed644a214ce98c680ff9ab5e6cb423e683f318bfd191d94711139494483a07b6496c064cda803fd8819858aeceabaa67464dcc6afd23b07ac1a9ecce690c070
-  data.tar.gz: 10cdce7ed52f9d9774b1b4846b100a03797913351a16eba1fa2fce251c901a38787f4a4adf00899e5282e90e0e2c9fed524958a43006bb39a29e7c88d15dce29
+  metadata.gz: a1dabc66e583524d094986af8e485e27c56176c87a1f66e995b7f1114a0d9289cb5389f9de88202299f05f66f992f9198d6e4bf31f2e153ac6f6b39cba32356e
+  data.tar.gz: abfa2425264961ca1eff57a07e674d9cad976377a649f9ea577ac0edeadc3b475a7061d4818e44405a938c1e251f4ab6e97d222cafe16c748bbb1eb3fc468ed9

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2024-11-02
+
+### Added
+
+- Added support for JRuby 9.4 by adding an implementation of Argon2id hashing
+  and verification using JRuby-OpenSSL's Bouncy Castle internals.
+- Added `output` to `Argon2id::Password` instances so the actual "output" part
+  of a password hash can be retrieved (and compared)
+
+### Changed
+
+- Verifying a password will now consistently raise an `ArgumentError` when
+  given an invalid encoded hash rather than an `Argon2id::Error`
+
 ## [0.3.0] - 2024-11-01
 
 ### Added
@@ -63,6 +77,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   reference C implementation of Argon2, the password-hashing function that won
   the Password Hashing Competition.
 
+[0.4.0]: https://github.com/mudge/argon2id/releases/tag/v0.4.0
 [0.3.0]: https://github.com/mudge/argon2id/releases/tag/v0.3.0
 [0.2.1]: https://github.com/mudge/argon2id/releases/tag/v0.2.1
 [0.2.0]: https://github.com/mudge/argon2id/releases/tag/v0.2.0

data/README.md

@@ -5,7 +5,7 @@ function that won the 2015 [Password Hashing Competition][].
 
 [![Build Status](https://github.com/mudge/argon2id/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/mudge/argon2id/actions)
 
-**Current version:** 0.3.0  
+**Current version:** 0.4.0  
 **Bundled Argon2 version:** libargon2.1 (20190702)
 
 ```ruby
@@ -13,7 +13,7 @@ Argon2id::Password.create("password").to_s
 #=> "$argon2id$v=19$m=19456,t=2,p=1$agNV6OfDL1OwE44WdrFCJw$ITrBwvCsW4b5GjgZuL67RCcvVMEWBWXtASc9TVyI3rY"
 
 password = Argon2id::Password.new("$argon2id$v=19$m=19456,t=2,p=1$ZS2nBFWBpnt28HjtzNOW4w$SQ+p+dIcWbpzWpZQ/ZZFj8IQkyhYZf127U4QdkRmKFU")
-password == "password"      #=> true
+password == "password"     #=> true
 password == "not password" #=> false
 
 password.m_cost #=> 19456
@@ -143,7 +143,7 @@ password.is_password?("opensesame")    #=> true
 password.is_password?("notopensesame") #=> false
 ```
 
-The various parameters for the password can be retrieved:
+The various parts of the encoded password can be retrieved:
 
 ```ruby
 password = Argon2id::Password.new("$argon2id$v=19$m=256,t=2,p=1$c29tZXNhbHQ$nf65EOgLrQMR/uIPnA4rEsF5h7TKyQwu9U1bMCHGi/4")
@@ -153,6 +153,8 @@ password.m_cost      #=> 256
 password.t_cost      #=> 2
 password.parallelism #=> 1
 password.salt        #=> "somesalt"
+password.output
+#=> "\x9D\xFE\xB9\x10\xE8\v\xAD\x03\x11\xFE\xE2\x0F\x9C\x0E+\x12\xC1y\x87\xB4\xCA\xC9\f.\xF5M[0!\xC6\x8B\xFE"
 ```
 
 ### Errors
@@ -166,9 +168,16 @@ Argon2id::Password.create("password", salt_len: 0)
 
 ## Requirements
 
-This gem requires the following to run:
+This gem requires any of the following to run:
 
 * [Ruby](https://www.ruby-lang.org/en/) 2.6 to 3.3
+* [JRuby](https://www.jruby.org) 9.4
+* [TruffleRuby](https://www.graalvm.org/ruby/) 24.1
+
+> [!NOTE]
+> The JRuby version of the gem uses
+> [JRuby-OpenSSL](https://github.com/jruby/jruby-openssl)'s implementation of
+> Argon2 instead of the reference C implementation.
 
 ### Native gems
 
@@ -180,6 +189,7 @@ Where possible, a pre-compiled native gem will be provided for the following pla
     * [musl](https://musl.libc.org/)-based systems such as [Alpine](https://alpinelinux.org) are supported as long as a [glibc-compatible library is installed](https://wiki.alpinelinux.org/wiki/Running_glibc_programs)
 * macOS `x86_64-darwin` and `arm64-darwin`
 * Windows `x64-mingw32` and `x64-mingw-ucrt`
+* Java: any platform running JRuby 9.4 or higher
 
 ### Verifying the gems
 
@@ -188,11 +198,11 @@ notes](https://github.com/mudge/argon2id/releases) for each version and can be
 checked with `sha256sum`, e.g.
 
 ```console
-$ gem fetch argon2id -v 0.2.1
-Fetching argon2id-0.2.1-arm64-darwin.gem
-Downloaded argon2id-0.2.1-arm64-darwin
-$ sha256sum argon2id-0.2.1-arm64-darwin.gem
-aea93700e989e421dd4e66b99038b9fec1acc9a265fe9d35e2100ceb5c18e5a9  argon2id-0.2.1-arm64-darwin.gem
+$ gem fetch argon2id -v 0.3.0
+Fetching argon2id-0.3.0-arm64-darwin.gem
+Downloaded argon2id-0.3.0-arm64-darwin
+$ sha256sum argon2id-0.3.0-arm64-darwin.gem
+9d49de6840942b48d020dddd422a1577fde7289ccb08a637bdb29f4a09b4e181  argon2id-0.3.0-arm64-darwin.gem
 ```
 
 [GPG](https://www.gnupg.org/) signatures are attached to each release (the
@@ -202,8 +212,8 @@ from a public keyserver, e.g. `gpg --keyserver keyserver.ubuntu.com --recv-key
 0x39AC3530070E0F75`):
 
 ```console
-$ gpg --verify argon2id-0.2.1-arm64-darwin.gem.sig argon2id-0.2.1-arm64-darwin.gem
-gpg: Signature made Fri  1 Nov 15:06:30 2024 GMT
+$ gpg --verify argon2id-0.3.0-arm64-darwin.gem.sig argon2id-0.3.0-arm64-darwin.gem
+gpg: Signature made Fri  1 Nov 18:15:47 2024 GMT
 gpg:                using RSA key 702609D9C790F45B577D7BEC39AC3530070E0F75
 gpg: Good signature from "Paul Mucur <mudge@mudge.name>" [unknown]
 gpg:                 aka "Paul Mucur <paul@ghostcassette.com>" [unknown]

data/Rakefile

@@ -20,6 +20,13 @@ ENV["RUBY_CC_VERSION"] = %w[3.3.0 3.2.0 3.1.0 3.0.0 2.7.0 2.6.0].join(":")
 
 gemspec = Gem::Specification.load("argon2id.gemspec")
 
+if RUBY_PLATFORM == "java"
+  gemspec.files.reject! { |path| File.fnmatch?("ext/*", path) }
+  gemspec.extensions.clear
+  gemspec.platform = Gem::Platform.new("java")
+  gemspec.required_ruby_version = ">= 3.1.0"
+end
+
 Gem::PackageTask.new(gemspec).define
 
 Rake::ExtensionTask.new("argon2id", gemspec) do |e|
@@ -50,6 +57,15 @@ namespace :gem do
       SCRIPT
     end
   end
+
+  desc "Compile gem for JRuby"
+  task :jruby do
+    RakeCompilerDock.sh <<~SCRIPT, rubyvm: "jruby", platform: "jruby", verbose: true
+      gem install bundler --no-document &&
+      bundle &&
+      bundle exec rake gem
+    SCRIPT
+  end
 end
 
 task default: [:compile, :test]

data/ext/argon2id/argon2id.c

@@ -70,6 +70,9 @@ rb_argon2id_verify(VALUE module, VALUE encoded, VALUE pwd) {
   if (result == ARGON2_VERIFY_MISMATCH) {
     return Qfalse;
   }
+  if (result == ARGON2_DECODING_FAIL || result == ARGON2_DECODING_LENGTH_FAIL) {
+    rb_raise(rb_eArgError, "%s", argon2_error_message(result));
+  }
 
   rb_raise(cArgon2idError, "%s", argon2_error_message(result));
 }

data/lib/argon2id/password.rb

@@ -44,7 +44,7 @@ module Argon2id
       \$
       ([a-zA-Z0-9+/]+)
       \$
-      [a-zA-Z0-9+/]+
+      ([a-zA-Z0-9+/]+)
       \z
     }x.freeze
 
@@ -69,6 +69,9 @@ module Argon2id
     # The salt.
     attr_reader :salt
 
+    # The hash output.
+    attr_reader :output
+
     # Create a new Password object that hashes a given plain text password +pwd+.
     #
     # - +:t_cost+: integer (default 2) the "time cost" given as a number of iterations
@@ -101,8 +104,6 @@ module Argon2id
       )
     end
 
-    # call-seq: Argon2id::Password.new(encoded)
-    #
     # Create a new Password with the given encoded password hash.
     #
     #   password = Argon2id::Password.new("$argon2id$v=19$m=19456,t=2,p=1$FI8yp1gXbthJCskBlpKPoQ$nOfCCpS2r+I8GRN71cZND4cskn7YKBNzuHUEO3YpY2s")
@@ -113,11 +114,12 @@ module Argon2id
 
       @encoded = $&
       @type = $1
-      @version = ($2 || 0x10).to_i
-      @m_cost = $3.to_i
-      @t_cost = $4.to_i
-      @parallelism = $5.to_i
+      @version = Integer($2 || 0x10)
+      @m_cost = Integer($3)
+      @t_cost = Integer($4)
+      @parallelism = Integer($5)
       @salt = $6.unpack1("m")
+      @output = $7.unpack1("m")
     end
 
     # Return the encoded password hash.

data/lib/argon2id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Argon2id
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/argon2id.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
-begin
-  ::RUBY_VERSION =~ /(\d+\.\d+)/
-  require_relative "#{Regexp.last_match(1)}/argon2id.so"
-rescue LoadError
-  require "argon2id.so"
+if RUBY_PLATFORM == "java"
+  require "openssl"
+else
+  begin
+    ::RUBY_VERSION =~ /(\d+\.\d+)/
+    require_relative "#{Regexp.last_match(1)}/argon2id.so"
+  rescue LoadError
+    require "argon2id.so"
+  end
 end
 
 require "argon2id/version"
@@ -48,4 +52,54 @@ module Argon2id
     # The default desired length of the hash in bytes used by Argon2id::Password.create
     attr_accessor :output_len
   end
+
+  if RUBY_PLATFORM == "java"
+    Error = Class.new(StandardError)
+
+    def self.hash_encoded(t_cost, m_cost, parallelism, pwd, salt, hashlen)
+      raise Error, "Salt is too short" unless String(salt).bytesize.positive?
+
+      hash = Java::byte[Integer(hashlen)].new
+      params = Java::OrgBouncycastleCryptoParams::Argon2Parameters::Builder
+        .new(Java::OrgBouncycastleCryptoParams::Argon2Parameters::ARGON2_id)
+        .with_salt(String(salt).to_java_bytes)
+        .with_parallelism(Integer(parallelism))
+        .with_memory_as_kb(Integer(m_cost))
+        .with_iterations(Integer(t_cost))
+        .build
+      generator = Java::OrgBouncycastleCryptoGenerators::Argon2BytesGenerator.new
+      encoder = Java::JavaUtil::Base64.get_encoder.without_padding
+
+      generator.init(params)
+      generator.generate_bytes(String(pwd).to_java_bytes, hash)
+
+      encoded_salt = encoder.encode_to_string(params.get_salt)
+      encoded_output = encoder.encode_to_string(hash)
+
+      "$argon2id$v=#{params.get_version}$m=#{params.get_memory}," \
+        "t=#{params.get_iterations},p=#{params.get_lanes}" \
+        "$#{encoded_salt}$#{encoded_output}"
+    rescue => e
+      raise Error, e.message
+    end
+
+    def self.verify(encoded, pwd)
+      password = Password.new(encoded)
+      other_password = Password.new(
+        hash_encoded(
+          password.t_cost,
+          password.m_cost,
+          password.parallelism,
+          String(pwd),
+          password.salt,
+          password.output.bytesize
+        )
+      )
+
+      Java::OrgBouncycastleUtil::Arrays.constant_time_are_equal(
+        password.output.to_java_bytes,
+        other_password.output.to_java_bytes
+      )
+    end
+  end
 end

data/test/test_hash_encoded.rb

@@ -17,42 +17,32 @@ class TestHashEncoded < Minitest::Test
   end
 
   def test_raises_with_too_short_output
-    error = assert_raises(Argon2id::Error) do
+    assert_raises(Argon2id::Error) do
       Argon2id.hash_encoded(2, 256, 1, "password", "somesalt", 1)
     end
-
-    assert_equal "Output is too short", error.message
   end
 
   def test_raises_with_too_few_lanes
-    error = assert_raises(Argon2id::Error) do
+    assert_raises(Argon2id::Error) do
       Argon2id.hash_encoded(2, 256, 0, "password", "somesalt", 32)
     end
-
-    assert_equal "Too few lanes", error.message
   end
 
   def test_raises_with_too_small_memory_cost
-    error = assert_raises(Argon2id::Error) do
+    assert_raises(Argon2id::Error) do
       Argon2id.hash_encoded(2, 0, 1, "password", "somesalt", 32)
     end
-
-    assert_equal "Memory cost is too small", error.message
   end
 
   def test_raises_with_too_small_time_cost
-    error = assert_raises(Argon2id::Error) do
+    assert_raises(Argon2id::Error) do
       Argon2id.hash_encoded(0, 256, 1, "password", "somesalt", 32)
     end
-
-    assert_equal "Time cost is too small", error.message
   end
 
   def test_raises_with_too_short_salt
-    error = assert_raises(Argon2id::Error) do
-      Argon2id.hash_encoded(0, 256, 1, "password", "", 32)
+    assert_raises(Argon2id::Error) do
+      Argon2id.hash_encoded(2, 256, 1, "password", "", 32)
     end
-
-    assert_equal "Salt is too short", error.message
   end
 end

data/test/test_verify.rb

@@ -19,7 +19,7 @@ class TestVerify < Minitest::Test
   end
 
   def test_raises_if_given_invalid_encoded
-    assert_raises(Argon2id::Error) do
+    assert_raises(ArgumentError) do
       Argon2id.verify("", "opensesame")
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: argon2id
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Mucur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-01 00:00:00.000000000 Z
+date: 2024-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler