bcrypt_pbkdf 1.2.0.beta1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 816bab3086720b43cba29bca47b1dcb3c999d9361e39c31127b10103c48e64bd
+  data.tar.gz: e4ca3184a544e3ea87e4a286f263313db30821464a664f4c539db3299ce60bbd
+SHA512:
+  metadata.gz: 97550f0668367f030911cd45a069edc57f9221fe6a7192d28ea1daf4388835cfc1ed02bb1a8c17ce31fe53ebe09d381913c359825846995ef3324469c47ba000
+  data.tar.gz: a7131dc172fe4f8be5d153899a74c6c4885a51f18f865e3f9f4e11a4433057d7e1cc4ebeb67d5aa76c57313769096b08aef0ccada6c072edb996e998cde09ee9

data/.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+---
+name: ci
+
+on:
+  pull_request:
+    branches: [ main ]
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  windows:
+    name: ${{ matrix.os }} ruby ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, 3.4, head, mingw, mswin, ucrt]
+        os: [windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake compile
+      - run: bundle exec rake test
+
+  unix:
+    name: ${{ matrix.os }} ruby ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, 3.4, head]
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake compile
+      - run: bundle exec rake test
+
+  jruby:
+    name: ubuntu-latest ruby jruby
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: jruby
+          bundler-cache: true
+      - run: bundle exec rake compile:java
+      - run: bundle exec rake test
+
+  memcheck:
+    name: Memory leak check (valgrind)
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: Gemfile.memcheck
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - run: sudo apt-get install -y valgrind
+      - run: bundle exec rake compile
+      - run: bundle exec rake memcheck

data/.gitignore

@@ -0,0 +1,6 @@
+lib/*.jar
+lib/*.so
+pkg/
+tmp/
+Gemfile.lock
+.bundle/

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# 1.2.0.beta1
+
+* JRuby support: native Java extension (`-java` gem variant) [#30]
+* Fix: missing salt size cap guard (`saltlen > 1<<20`) in Java implementation to match C behavior [#30]
+* Fix: memory leak on error state in C extension [#34]
+* Sync `bcrypt_pbkdf.c` (v1.13→v1.17) and `blowfish.c` (v1.19→v1.20) from OpenBSD [#36]
+* Sync `blf.h` to OpenBSD v1.8, drop advertising clause [#38]
+* Fix compatibility with minitest 6 [#28]
+
+# 1.1.2
+
+* Add Ruby 3.4 support [#26]
+
+# 1.1.1
+
+* Fix cross-compile and native gem publishing [#22]
+* Fix compile on Windows (missing bzero)
+* Replace Travis CI with GitHub Actions
+* Minitest 5.19 compatibility [#21]
+
+# 1.1.0
+
+* Ruby 3.0 support
+* Support rubies 2.0–2.7 in Windows cross-compile
+* Fix inline static function declarations [#15]
+* Add Linux on Power (ppc64) support [#11]
+* Use size_t for xmalloc [#7]
+* Fix gem summary typo [#9]
+
+# 1.0.1
+
+* Fix compile on Solarish platforms [#3]
+* Drop rbnacl test dependency, use native OpenSSL instead [#6]
+* Fix spelling in source [#2]
+
+# 1.0.0
+
+* Initial release

data/COPYING

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright 2007-2016: Miklós Fazekas <mfazekas@szemafor.com>
+C implementation of bcrypt_pbkdf: OpenBSD: Copyright (c) 2013 Ted Unangst <tedu@openbsd.org>
+
+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/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.memcheck

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'ruby_memcheck'

data/README.md

@@ -0,0 +1,41 @@
+# bcrypt_pbkdf-ruby
+
+bcrypt_pbkdf is a ruby gem implementing bcrypt_pbkdf from OpenBSD. This is currently used by net-ssh to read password encrypted Ed25519 keys.
+
+[![Build Status](https://github.com/net-ssh/bcrypt_pbkdf-ruby/actions/workflows/ci.yml/badge.svg?branch=master&event=push)](https://github.com/net-ssh/bcrypt_pbkdf-ruby/actions/workflows/ci.yml)
+
+## Acknowledgements
+
+* The gut of the code is based on OpenBSD's bcrypt_pbkdf.c implementation
+* Some ideas/code were taken adopted bcrypt-ruby: https://github.com/codahale/bcrypt-ruby
+
+## Upstream sources
+
+The C sources are synced from openssh-portable, which tracks OpenBSD CVS:
+
+| File | OpenBSD version |
+|------|----------------|
+| `ext/mri/bcrypt_pbkdf.c` | [v1.17](https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/lib/libutil/bcrypt_pbkdf.c?rev=1.17) |
+| `ext/mri/blowfish.c` | [v1.20](https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/lib/libcrypto/blowfish.c?rev=1.20) |
+| `ext/mri/blf.h` | [v1.8](https://cvsweb.openbsd.org/cgi-bin/cvsweb/src/lib/libcrypto/blf.h?rev=1.8) |
+
+## Links
+
+* http://www.tedunangst.com/flak/post/bcrypt-pbkdf
+
+## Building
+
+For windows and osx cross build make sure you checked out the gem source under the home directory and have docker installed.
+
+```sh
+gem install rake-compiler-dock
+```
+
+```sh
+bundle exec rake compile
+bundle exec rake test
+bundle exec rake clean clobber
+bundle exec rake gem:all
+bundle exec rake release
+bundle exec rake gem:release
+```

data/Rakefile

@@ -0,0 +1,208 @@
+require 'rake/testtask'
+require 'rubygems/package_task'
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+begin
+  require 'rake/javaextensiontask'
+rescue LoadError
+end
+require 'rake/clean'
+require 'rdoc/task'
+require 'benchmark'
+require 'rake_compiler_dock'
+
+begin
+  require 'ruby_memcheck'
+  RubyMemcheck::TestTask.new(memcheck: :compile) do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+  end
+rescue LoadError
+end
+
+CLEAN.add("{ext,lib}/**/*.{o,so}", "pkg")
+CLEAN.add("{ext,lib}/**/*.{jar,class}")
+
+cross_rubies = ["3.4.0", "3.3.0", "3.2.0", "3.1.0", "3.0.0", "2.7.0"]
+cross_platforms = [
+  "arm64-darwin",
+  "x64-mingw-ucrt",
+  "x64-mingw32",
+  "x86-mingw32",
+  "x86_64-darwin",
+]
+ENV["RUBY_CC_VERSION"] = cross_rubies.join(":")
+
+GEMSPEC = Gem::Specification.load("bcrypt_pbkdf.gemspec")
+
+task :default => [:compile, :spec]
+
+desc "Run all tests"
+Rake::TestTask.new do |t|
+  #t.pattern =
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts = ['-w']
+  t.libs << "test"
+  t.verbose = true
+end
+task :spec => :test
+
+desc 'Generate RDoc'
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.options += GEMSPEC.rdoc_options
+  rdoc.template = ENV['TEMPLATE'] if ENV['TEMPLATE']
+  rdoc.rdoc_files.include(*GEMSPEC.extra_rdoc_files)
+end
+
+unless RUBY_PLATFORM == 'java'
+  Rake::ExtensionTask.new("bcrypt_pbkdf_ext", GEMSPEC) do |ext|
+    ext.ext_dir = 'ext/mri'
+    ext.cross_compile = true
+    ext.cross_platform = cross_platforms
+    ext.cross_config_options << "--enable-cross-build" # so extconf.rb knows we're cross-compiling
+  end
+end
+
+if defined?(Rake::JavaExtensionTask)
+  Rake::JavaExtensionTask.new("bcrypt_pbkdf_ext", GEMSPEC) do |ext|
+    ext.ext_dir = 'ext/jruby'
+    ext.source_pattern = '**/*.java'
+    ext.source_version = '8'
+    ext.target_version = '8'
+    ext.lint_option = '-options'
+  end
+end
+
+namespace "gem" do
+  cross_platforms.each do |platform|
+    desc "build native gem for #{platform}"
+    task platform do
+      RakeCompilerDock.sh(<<~EOF, platform: platform, verbose: true)
+        gem install bundler --no-document &&
+        BUNDLE_IGNORE_CONFIG=1 BUNDLE_PATH=.bundle/#{platform} bundle &&
+        BUNDLE_IGNORE_CONFIG=1 BUNDLE_PATH=.bundle/#{platform} bundle exec rake gem:#{platform}:buildit
+      EOF
+    end
+
+    namespace platform do
+      # this runs in the rake-compiler-dock docker container
+      task "buildit" do
+        # use Task#invoke because the pkg/*gem task is defined at runtime
+        Rake::Task["native:#{platform}"].invoke
+        Rake::Task["pkg/#{GEMSPEC.full_name}-#{Gem::Platform.new(platform)}.gem"].invoke
+      end
+
+      task "release" do
+        sh "gem push pkg/#{GEMSPEC.full_name}-#{Gem::Platform.new(platform)}.gem"
+      end
+    end
+  end
+
+  desc "build java gem for JRuby"
+  task "java" do
+    Rake::Task["java:#{GEMSPEC.name}"].invoke
+    Rake::Task["pkg/#{GEMSPEC.full_name}-java.gem"].invoke
+  end
+
+  namespace "java" do
+    task "release" do
+      sh "gem push pkg/#{GEMSPEC.full_name}-java.gem"
+    end
+  end
+
+  desc "build native gem for all platforms"
+  task "all" do
+    cross_platforms.each do |platform|
+      Rake::Task["gem:#{platform}"].invoke
+    end
+    Rake::Task["gem:java"].invoke if defined?(Rake::JavaExtensionTask) && ENV['JRUBY_HOME']
+  end
+
+  desc "release native gem for all platforms"
+  task "release" do
+    cross_platforms.each do |platform|
+      Rake::Task["gem:#{platform}:release"].invoke
+    end
+    Rake::Task["gem:java:release"].invoke if File.exist?("pkg/#{GEMSPEC.full_name}-java.gem")
+  end
+end
+
+def change_version(&block)
+  version = GEMSPEC.version
+  version_file = 'bcrypt_pbkdf.gemspec'
+  raise "No version found" if version.nil?
+  final = version.segments.take_while{ |i| i.is_a?(Integer) }.to_a
+  pre = version.segments.drop_while{ |i| i.is_a?(Integer) }.to_a.join("")
+  pre = nil if pre.empty?
+  tiny = final.last
+  result = block[pre: pre, tiny: tiny]
+  raise ArgumentError, "Version change logic should always return a pre" unless result.key?(:pre)
+
+  puts "result: #{result.inspect}"
+
+  new_pre = result[:pre] || []
+  new_tiny = result[:tiny] || tiny
+  final[-1] = new_tiny
+  new_version = Gem::Version.new([final, *new_pre].join("."))
+
+  found = false
+  File.open("#{version_file}.new", "w") do |f|
+    File.readlines(version_file).each do |line|
+      match = /^(\s+s\.version\s*=\s*\')[\d[a-z]\.]+(\'\s*)$/.match(line)
+      if match
+        prefix = match[1]
+        postfix = match[2]
+        new_line = "#{prefix}#{new_version.to_s}#{postfix}"
+        puts "Changing:\n  - #{line}  + #{new_line}"
+        line = new_line
+        found = true
+      end
+      f.write(line)
+    end
+    raise ArgumentError, "Cound not find version line in #{version_file}" unless found
+  end
+
+  FileUtils.mv version_file, "#{version_file}.old"
+  FileUtils.mv "#{version_file}.new", version_file
+  FileUtils.rm_f "#{version_file}.old"
+end
+
+namespace :vbump do
+  desc "Final release"
+  task :final do
+    change_version do |pre:, tiny:|
+      _ = tiny
+      if pre.nil?
+        { tiny: tiny + 1, pre: nil }
+      else
+        raise ArgumentError, "Unexpected pre: #{pre}" if pre.nil?
+
+        { pre: nil }
+      end
+    end
+  end
+
+  desc "Increment prerelease"
+  task :pre, [:type] do |_t, args|
+    change_version do |pre:, tiny:|
+      puts " PRE => #{pre.inspect}"
+      match = /^([a-z]+)(\d+)/.match(pre)
+      raise ArgumentError, "Unexpected pre: #{pre}" if match.nil? && args[:type].nil?
+
+      if match.nil? || (!args[:type].nil? && args[:type] != match[1])
+        if pre.nil?
+          { pre: "#{args[:type]}1", tiny: tiny + 1 }
+        else
+          { pre: "#{args[:type]}1" }
+        end
+      else
+        { pre: "#{match[1]}#{match[2].to_i + 1}" }
+      end
+    end
+  end
+end
+
+task "package" => cross_platforms.map { |p| "gem:#{p}" } # "package" task for all the native platforms
+
+Rake::Task["package"].prerequisites.prepend("compile")

data/bcrypt_pbkdf.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = 'bcrypt_pbkdf'
+  s.version = '1.2.0.beta1'
+
+  s.summary = "OpenBSD's bcrypt_pbkdf (a variant of PBKDF2 with bcrypt-based PRF)"
+  s.description = <<-EOF
+    This gem implements bcrypt_pbkdf (a variant of PBKDF2 with bcrypt-based PRF)
+  EOF
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+  s.add_development_dependency 'rake-compiler', '~> 1.2.5'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'openssl', '~> 3'
+  s.add_development_dependency 'rdoc', '~> 6'
+  s.add_development_dependency 'rake-compiler-dock', '~> 1.5.0'
+  s.add_development_dependency 'benchmark', '~> 0.4.0'
+
+  s.rdoc_options += ['--title', 'bcrypt_pbkdf', '--line-numbers', '--inline-source', '--main', 'README.md']
+  s.extra_rdoc_files += ['README.md', 'COPYING', 'CHANGELOG.md', *Dir['lib/**/*.rb']]
+
+  s.extensions = 'ext/mri/extconf.rb'
+
+  s.authors = ["Miklos Fazekas"]
+  s.email = "mfazekas@szemafor.com"
+  s.homepage = "https://github.com/net-ssh/bcrypt_pbkdf-ruby"
+  s.license = "MIT"
+end