argon2 1.1.5 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9425c5c639ac3e940ffffe3f9baa5967976ad2caa49d0716db0de43aa6d41b66
-  data.tar.gz: 607eff42d6c915f2528d5e61f95d264bdace086515a250188e0f937397b684b1
+  metadata.gz: ff5c2dcd38a21e51982265caf83a721327a8cff1a09acc5c51312ce92d2f5619
+  data.tar.gz: ab787b9e4ee2a039e286f5b96ebb65da86845749c7003de1b43061a2da2c3699
 SHA512:
-  metadata.gz: 60b5ff68f0e29fa1c40dc2e9a10e21f585dacd1d95af4a219166be38e9b2734d8bcae85010245ceb5a2d8782f8f65906bce4f951159eaf5bd1e9b8bccd98cf71
-  data.tar.gz: e8d1074c9ad878cb2a7b7e3791b377f0fbf573ead9d9432ad178d1e4c4af4de80d337455d7fb438fd0e5ad15e2bcfa0f5091254674b7c5d45145ac8ce9e5f6e1
+  metadata.gz: 1b47bef62063b2871cd0c6235fe38e76b892b9c4b888d0b9798ccf39a6cc7daa2f4539b6a4fa1829635e5970401a59b822bcd1d1f72bfb71b9d3c79781ecf1ae
+  data.tar.gz: 476a21e271c981101b51cd0fe32ce6182635994273895de8f57c26224f9f4e4fd883a1a40139fa95c9672a2cb8dea920bce9e362e01fc0893cacfd3b28ce9625

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+name: Rubocop
+
+# Run this workflow every time a new commit pushed to your repository
+on: push
+
+jobs:
+
+  rubocop:
+    name: Rubocopchecks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run Rubocop
+        uses: gimenete/rubocop-action@1.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+name: Test Suite
+
+on: push
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', 2.7, 2.5]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }} 
+    - name: Install dependencies
+      run: bundle install
+    - name: Init submodules
+      run: git submodule update --init --recursive
+    - name: Build C library
+      run: bin/setup
+    - name: Test C library
+      run: cd ext/argon2_wrap/ && make test && cd ../..
+    - name: Run tests
+      run: bundle exec rake
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

data/.rubocop.yml

@@ -1,20 +1,26 @@
-
 Metrics/AbcSize:
   Max: 20
+
 Metrics/CyclomaticComplexity:
   Enabled: false
+
 Metrics/PerceivedComplexity:
   Enabled: false
-Metrics/LineLength:
+
+Layout/LineLength:
   Max: 160
+  Exclude:
+    - 'test/low_level_test.rb'
 
 Metrics/MethodLength:
   Max: 24
+  Exclude:
+    - 'test/low_level_test.rb'
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Enabled: false
 
-Layout/AlignArray:
+Layout/ArrayAlignment:
   Enabled: false
 
 # Configuration parameters: Exclude.
@@ -37,7 +43,7 @@ Style/HashSyntax:
 
 # Offense count: 1
 # Cop supports --auto-correct.
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   Exclude:
     - 'lib/argon2/errors.rb'
 
@@ -61,3 +67,142 @@ Layout/MultilineMethodCallBraceLayout:
     - 'lib/argon2.rb'
     - 'test/low_level_test.rb'
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/BeginEndAlignment: # (new in 0.91)
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor: # (new in 0.83)
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator: # (new in 0.82)
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands: # (new in 0.89)
+  Enabled: true
+Lint/ConstantDefinitionInBlock: # (new in 0.91)
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant: # (new in 0.84)
+  Enabled: true
+Lint/DuplicateElsifCondition: # (new in 0.88)
+  Enabled: true
+Lint/DuplicateRequire: # (new in 0.90)
+  Enabled: true
+Lint/DuplicateRescueException: # (new in 0.89)
+  Enabled: true
+Lint/EmptyConditionalBody: # (new in 0.89)
+  Enabled: true
+Lint/EmptyFile: # (new in 0.90)
+  Enabled: true
+Lint/FloatComparison: # (new in 0.89)
+  Enabled: true
+Lint/IdentityComparison: # (new in 0.91)
+  Enabled: true
+Lint/MissingSuper: # (new in 0.89)
+  Enabled: true
+Lint/MixedRegexpCaptureTypes: # (new in 0.85)
+  Enabled: true
+Lint/OutOfRangeRegexpRef: # (new in 0.89)
+  Enabled: true
+Lint/RaiseException: # (new in 0.81)
+  Enabled: true
+Lint/SelfAssignment: # (new in 0.89)
+  Enabled: true
+Lint/StructNewOverride: # (new in 0.81)
+  Enabled: true
+Lint/TopLevelReturnWithArgument: # (new in 0.89)
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
+  Enabled: true
+Lint/UnreachableLoop: # (new in 0.89)
+  Enabled: true
+Lint/UselessMethodDefinition: # (new in 0.90)
+  Enabled: true
+Lint/UselessTimes: # (new in 0.91)
+  Enabled: true
+Style/AccessorGrouping: # (new in 0.87)
+  Enabled: true
+Style/ArrayCoercion: # (new in 0.88)
+  Enabled: true
+Style/BisectedAttrAccessor: # (new in 0.87)
+  Enabled: true
+Style/CaseLikeIf: # (new in 0.88)
+  Enabled: true
+Style/CombinableLoops: # (new in 0.90)
+  Enabled: true
+Style/ExplicitBlockArgument: # (new in 0.89)
+  Enabled: true
+Style/ExponentialNotation: # (new in 0.82)
+  Enabled: true
+Style/GlobalStdStream: # (new in 0.89)
+  Enabled: true
+Style/HashAsLastArrayItem: # (new in 0.88)
+  Enabled: true
+Style/HashEachMethods: # (new in 0.80)
+  Enabled: true
+Style/HashLikeCase: # (new in 0.88)
+  Enabled: true
+Style/HashTransformKeys: # (new in 0.80)
+  Enabled: true
+Style/HashTransformValues: # (new in 0.80)
+  Enabled: true
+Style/KeywordParametersOrder: # (new in 0.90)
+  Enabled: true
+Style/OptionalBooleanParameter: # (new in 0.89)
+  Enabled: true
+Style/RedundantAssignment: # (new in 0.87)
+  Enabled: true
+Style/RedundantFetchBlock: # (new in 0.86)
+  Enabled: true
+Style/RedundantFileExtensionInRequire: # (new in 0.88)
+  Enabled: true
+Style/RedundantRegexpCharacterClass: # (new in 0.85)
+  Enabled: true
+Style/RedundantRegexpEscape: # (new in 0.85)
+  Enabled: true
+Style/RedundantSelfAssignment: # (new in 0.90)
+  Enabled: true
+Style/SingleArgumentDig: # (new in 0.89)
+  Enabled: true
+Style/SlicingWithRange: # (new in 0.83)
+  Enabled: true
+Style/SoleNestedConditional: # (new in 0.89)
+  Enabled: true
+Style/StringConcatenation: # (new in 0.89)
+  Enabled: true
+
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+

data/Changelog.md

@@ -1,3 +1,12 @@
+## v2.0.3: 2021-01-02
+- Address potential memory leak. Unlikely to be exploitable.
+
+## v2.0.0: 2019-01-06
+- Defaults to Argon2id for new hashes
+
+## v1.2.0: 2018-11-29
+- Support for verifying Argon2id format
+
 ## v1.1.5: 2018-04-30
 - Documentation updates
 - Pulled latest reference

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in argon2.gemspec

data/README.md

@@ -2,21 +2,20 @@
 
 This Ruby Gem provides FFI bindings, and a simplified interface, to the Argon2 algorithm. [Argon2](https://github.com/P-H-C/phc-winner-argon2) is the official winner of the Password Hashing Competition, a several year project to identify a successor to bcrypt/PBKDF/scrypt methods of securely storing passwords. This is an independant project and not official from the PHC team.
 
-
-[![Build Status](https://travis-ci.org/technion/ruby-argon2.svg?branch=master)](https://travis-ci.org/technion/ruby-argon2)
+![Build Status](https://github.com/technion/ruby-argon2/workflows/Test%20Suite/badge.svg)
 [![Code Climate](https://codeclimate.com/github/technion/ruby-argon2/badges/gpa.svg)](https://codeclimate.com/github/technion/ruby-argon2)
 [![Coverage Status](https://coveralls.io/repos/github/technion/ruby-argon2/badge.svg)](https://coveralls.io/github/technion/ruby-argon2)
 
 ## Design
 
-This project has several key tenants to its design:
+This project has several key tenets to its design:
 
 * The reference Argon2 implementation is to be used "unaltered". To ensure compliance with this goal, and encourage regular updates from upstream, the upstream library is implemented as a git submodule, and is intended to stay that way.
 * The FFI interface is kept as slim as possible, with wrapper classes preferred to implementing context structs in FFI
 * Security and maintainability take top priority. This can have an impact on platform support. A PR that contains platform specific code paths is unlikely to be accepted.
 * Tested platforms are MRI Ruby 2.2, 2.3 and JRuby 9000. No assertions are made on other platforms.
 * Errors from the C interface are raised as Exceptions. There are a lot of exception classes, but they tend to relate to things like very broken input, and code bugs. Calls to this library should generally not require a rescue.
-* Test suits should aim for 100% code coverage.
+* Test suites should aim for 100% code coverage.
 * Default work values should not be considered constants. I will increase them from time to time.
 * Not exposing the threads parameter is a design choice. I believe there is significant risk, and minimal gain in using a value other than '1'. Four threads on a four core box completely ties up the entire server to process one user logon. If you want more security, increase m_cost.
 * Many Rubocop errors have been disabled, but any commit should avoid new alerts or demonstrate their necessity.
@@ -45,7 +44,7 @@ hasher.create("password")
 ```
 
 If you follow this pattern, it is important to create a new `Argon2::Password` every time you generate a hash, in order to ensure a unique salt. See [issue 23](https://github.com/technion/ruby-argon2/issues/23) for more information.
-Alternatively, use this shotcut:
+Alternatively, use this shortcut:
 
 ```ruby
 Argon2::Password.create("password")
@@ -58,6 +57,13 @@ You can then use this function to verify a password against a given hash. Will r
 Argon2::Password.verify_password("password", secure_password)
 ```
 
+Version 1.2.x will now allow verifying an Argon2id password:
+
+```ruby
+Argon2::Password.verify_password("password", "$argon2id$v=19$m=262144,t=2,p=1$c29tZXNhbHQ$eP4eyR+zqlZX1y5xCFTkw9m5GYx0L5YWwvCFvtlbLow")
+  => true
+```
+
 Argon2 supports an optional key value. This should be stored securely on your server, such as alongside your database credentials. Hashes generated with a key will only validate when presented that key.
 
 ```ruby
@@ -66,13 +72,15 @@ argon = Argon2::Password.new(t_cost: 2, m_cost: 16, secret: KEY)
 myhash = argon.create("A password")
 Argon2::Password.verify_password("A password", myhash, KEY)
 ```
+## 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.
 
 ## Important notes regarding version 1.0 upgrade
 Version 1.0.0 included a major version bump over 0.1.4 due to several breaking changes. The first of these was an API change, which you can read the background on [here](https://github.com/technion/ruby-argon2/issues/9).
 
 The second of these is that the reference Argon2 implementation introduced an algorithm change, which produces a hash which is not backwards compatible. This is documented on [this PR on the C library](https://github.com/P-H-C/phc-winner-argon2/pull/115). This was a regrettable requirement to address a security concern in the algorithm itself. The two versions of the Argon2 algorithm are numbered 1.0 and 1.3 respectively.
 
-Shortly after this, version 1.0.0 of this gem was released with this breaking change, supporting only Argon2 v1.3. Further time later, the official encoding format was updated, with a spec that included the version number, and the library introduced backward compatibility. This should remove the likelyhood of such breaking changes in future. Version 1.1.0 will silently introduce the current version number in hashes, in order to avoid a further compatibility break.
+Shortly after this, version 1.0.0 of this gem was released with this breaking change, supporting only Argon2 v1.3. Further time later, the official encoding format was updated, with a spec that included the version number, and the library introduced backward compatibility. This should remove the likelihood of such breaking changes in future. Version 1.1.0 will silently introduce the current version number in hashes, in order to avoid a further compatibility break.
 
 
 ## Platform Issues
@@ -83,6 +91,8 @@ Windows is not. Nobody anywhere has the resources to support Ruby FFI code on Wi
 
 grsec introduces certain challenges. Please see [documentation here](https://github.com/technion/ruby-argon2/issues/15).
 
+See the .travis.yml file to see currently tested and supported Ruby versions.
+
 ## RubyDocs documentation
 
 [The usual URL](http://www.rubydoc.info/gems/argon2) will provide detailed documentation.
@@ -100,7 +110,7 @@ Although the low level C contains support for "secure memory wipe", any code hit
 
 ### Work maximums may be tighter than reference
 
-The reference implementation is aimed to provide secure hashing for many years. This implementation doesn't want you to DoS yourself in the meantime. Accordingly, some limits artificial limits exist on work powers. This gem can be much more agile in raising these as technology progresses.
+The reference implementation is aimed to provide secure hashing for many years. This implementation doesn't want you to DoS yourself in the meantime. Accordingly, some artificial limits exist on work powers. This gem can be much more agile in raising these as technology progresses.
 
 ### Salts in general
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 require 'rubocop/rake_task'

data/argon2.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'argon2/version'
@@ -20,13 +22,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency 'ffi', '~> 1.9'
-  spec.add_dependency 'ffi-compiler', '~> 0.1'
+  spec.add_dependency 'ffi', '~> 1.14'
+  spec.add_dependency 'ffi-compiler', '~> 1.0'
 
-  spec.add_development_dependency "bundler", '~> 1.10', '>= 1.10.5'
-  spec.add_development_dependency "coveralls", '~> 0.8'
+  spec.add_development_dependency "bundler", '~> 2.0'
   spec.add_development_dependency "minitest", '~> 5.8'
-  spec.add_development_dependency "rake", '~> 10.4', '>= 10.4.2'
-  spec.add_development_dependency "rubocop", '~> 0.49'
+  spec.add_development_dependency "rake", '~> 13.0.1'
+  spec.add_development_dependency "rubocop", '~> 1.7'
+  spec.add_development_dependency "simplecov", '~> 0.20'
+  spec.add_development_dependency "simplecov-lcov", '~> 0.8'
   spec.extensions << 'ext/argon2_wrap/extconf.rb'
 end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "argon2"

data/ext/argon2_wrap/argon_wrap.c

@@ -35,7 +35,8 @@ static int wrap_compare(const uint8_t *b1, const uint8_t *b2, size_t len) {
 
 int argon2_wrap_version(char *out, const char *pwd, size_t pwd_length,
         uint8_t *salt,  uint32_t saltlen, uint32_t t_cost, uint32_t m_cost, 
-        uint32_t lanes, uint8_t *secret, size_t secretlen, uint32_t version)
+        uint32_t lanes, uint8_t *secret, size_t secretlen, uint32_t version,
+        argon2_type type)
 {
     uint8_t hash[OUT_LEN];
     argon2_context context;
@@ -67,11 +68,22 @@ int argon2_wrap_version(char *out, const char *pwd, size_t pwd_length,
     context.flags = 0;
     context.version = version;
 
-    int result = argon2i_ctx(&context);
+    int result;
+    if (type == Argon2_i) {
+        result = argon2i_ctx(&context);
+    }  else if (type == Argon2_id) {
+        result = argon2id_ctx(&context);
+    } else if (type == Argon2_d) {
+        result = argon2d_ctx(&context);
+    } else {
+        // Unsupported type
+        return ARGON2_ENCODING_FAIL;
+    }
+
     if (result != ARGON2_OK)
         return result;
 
-    encode_string(out, ENCODE_LEN + saltlen, &context, Argon2_i);
+    encode_string(out, ENCODE_LEN + saltlen, &context, type);
     return ARGON2_OK;
 }
  
@@ -83,7 +95,7 @@ int argon2_wrap(char *out, const char *pwd, size_t pwd_length,
         uint32_t lanes, uint8_t *secret, size_t secretlen)
 {
     return argon2_wrap_version(out, pwd, pwd_length, salt, saltlen,
-            t_cost, m_cost, lanes, secret, secretlen, ARGON2_VERSION_13);
+            t_cost, m_cost, lanes, secret, secretlen, ARGON2_VERSION_13, Argon2_id);
 }
 
 int wrap_argon2_verify(const char *encoded, const char *pwd,
@@ -95,6 +107,7 @@ int wrap_argon2_verify(const char *encoded, const char *pwd,
     char *out;
     memset(&ctx, 0, sizeof(argon2_context));
     size_t encoded_len;
+    argon2_type type;
     
     encoded_len = strlen(encoded);
     /* larger than max possible values */
@@ -109,7 +122,20 @@ int wrap_argon2_verify(const char *encoded, const char *pwd,
         return ARGON2_MEMORY_ALLOCATION_ERROR;
     }
 
-    if(decode_string(&ctx, encoded, Argon2_i) != ARGON2_OK) {
+    if (memcmp(encoded, "$argon2id", strlen("$argon2id")) == 0) {
+        type = Argon2_id;
+    } else if (memcmp(encoded, "$argon2i", strlen("$argon2i")) == 0) {
+        type = Argon2_i;
+    } else if (memcmp(encoded, "$argon2d", strlen("$argon2d")) == 0) {
+        type = Argon2_d;
+    } else {
+        // Other types not yet supported
+        free(ctx.salt);
+        free(ctx.out);
+        return ARGON2_DECODING_FAIL;
+    }
+
+    if (decode_string(&ctx, encoded, type) != ARGON2_OK) {
         free(ctx.salt);
         free(ctx.out);
         return ARGON2_DECODING_FAIL;
@@ -124,7 +150,7 @@ int wrap_argon2_verify(const char *encoded, const char *pwd,
 
     ret = argon2_wrap_version(out, pwd, pwdlen, ctx.salt, ctx.saltlen,
             ctx.t_cost, ctx.m_cost, ctx.lanes, secret, secretlen,
-            ctx.version);
+            ctx.version, type);
 
     free(ctx.salt);