htauth 2.3.0 → 3.0.0

data/lib/htauth.rb

@@ -1,46 +1,47 @@
-#-- 
+# frozen_string_literal: true
+
+#--
 # Copyrigth (c) 2008 Jeremy Hinegardner
 # All rights reserved.  See LICENSE and/or COPYING for details
 #++
 
+# Public: module wrapper for library
+#
 module HTAuth
-
   # The root directory of the project is considered to be the parent directory
   # of the 'lib' directory.
   #
   def self.root_dir
     unless @root_dir
-      path_parts = ::File.expand_path( __FILE__ ).split( ::File::SEPARATOR )
-      lib_index  = path_parts.rindex( 'lib' )
-      @root_dir  = path_parts[ 0...lib_index].join( ::File::SEPARATOR ) + ::File::SEPARATOR
+      path_parts = ::File.expand_path(__FILE__).split(::File::SEPARATOR)
+      lib_index  = path_parts.rindex("lib")
+      @root_dir  = path_parts[0...lib_index].join(::File::SEPARATOR) + ::File::SEPARATOR
     end
-    return @root_dir
+    @root_dir
   end
 
-  def self.lib_path( *args )
-    self.sub_path( "lib", *args )
+  def self.lib_path(*args)
+    sub_path("lib", *args)
   end
 
-  def self.sub_path( sub, *args )
-    sp = ::File.join( root_dir, sub ) + ::File::SEPARATOR
-    sp = ::File.join( sp, *args ) if args
+  def self.sub_path(sub, *args)
+    sp = ::File.join(root_dir, sub) + ::File::SEPARATOR
+    ::File.join(sp, *args) if args
   end
-
 end
 
-require 'htauth/version'
-require 'htauth/algorithm'
-require 'htauth/argon2'
-require 'htauth/bcrypt'
-require 'htauth/crypt'
-require 'htauth/digest_entry'
-require 'htauth/digest_file'
-require 'htauth/entry'
-require 'htauth/error'
-require 'htauth/file'
-require 'htauth/md5'
-require 'htauth/passwd_entry'
-require 'htauth/passwd_file'
-require 'htauth/plaintext'
-require 'htauth/sha1'
-
+require "htauth/version"
+require "htauth/algorithm"
+require "htauth/argon2"
+require "htauth/bcrypt"
+require "htauth/crypt"
+require "htauth/digest_entry"
+require "htauth/digest_file"
+require "htauth/entry"
+require "htauth/error"
+require "htauth/file"
+require "htauth/md5"
+require "htauth/passwd_entry"
+require "htauth/passwd_file"
+require "htauth/plaintext"
+require "htauth/sha1"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: htauth
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
-autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2026-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -39,89 +38,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: argon2
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.21'
-- !ruby/object:Gem::Dependency
-  name: minitest-junit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.6'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.6'
 description: HTAuth provides an API and commandline tools for managing Apache/httpd
   style htpasswd and htdigest files.
 email: jeremy@copiousfreetime.org
@@ -132,17 +61,18 @@ extensions: []
 extra_rdoc_files:
 - CONTRIBUTING.md
 - HISTORY.md
+- LICENSE.txt
 - Manifest.txt
 - README.md
 files:
 - CONTRIBUTING.md
 - HISTORY.md
-- LICENSE
+- LICENSE.txt
 - Manifest.txt
 - README.md
-- Rakefile
-- bin/htdigest-ruby
-- bin/htpasswd-ruby
+- exe/htdigest-ruby
+- exe/htpasswd-ruby
+- htauth.gemspec
 - lib/htauth.rb
 - lib/htauth/algorithm.rb
 - lib/htauth/argon2.rb
@@ -164,30 +94,6 @@ files:
 - lib/htauth/plaintext.rb
 - lib/htauth/sha1.rb
 - lib/htauth/version.rb
-- spec/algorithm_spec.rb
-- spec/argon2_spec.rb
-- spec/bcrypt_spec.rb
-- spec/cli/digest_spec.rb
-- spec/cli/passwd_spec.rb
-- spec/crypt_spec.rb
-- spec/digest_entry_spec.rb
-- spec/digest_file_spec.rb
-- spec/md5_spec.rb
-- spec/passwd_entry_spec.rb
-- spec/passwd_file_spec.rb
-- spec/plaintext_spec.rb
-- spec/sha1_spec.rb
-- spec/spec_helper.rb
-- spec/test.add.digest
-- spec/test.add.passwd
-- spec/test.delete.digest
-- spec/test.delete.passwd
-- spec/test.original.digest
-- spec/test.original.passwd
-- spec/test.update.digest
-- spec/test.update.passwd
-- tasks/default.rake
-- tasks/this.rb
 homepage: http://github.com/copiousfreetime/htauth
 licenses:
 - MIT
@@ -196,7 +102,6 @@ metadata:
   changelog_uri: https://github.com/copiousfreetime/htauth/blob/master/HISTORY.md
   homepage_uri: https://github.com/copiousfreetime/htauth
   source_code_uri: https://github.com/copiousfreetime/htauth
-post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -208,38 +113,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: HTAuth provides an API and commandline tools for managing Apache/httpd style
   htpasswd and htdigest files.
-test_files:
-- spec/algorithm_spec.rb
-- spec/argon2_spec.rb
-- spec/bcrypt_spec.rb
-- spec/cli/digest_spec.rb
-- spec/cli/passwd_spec.rb
-- spec/crypt_spec.rb
-- spec/digest_entry_spec.rb
-- spec/digest_file_spec.rb
-- spec/md5_spec.rb
-- spec/passwd_entry_spec.rb
-- spec/passwd_file_spec.rb
-- spec/plaintext_spec.rb
-- spec/sha1_spec.rb
-- spec/spec_helper.rb
-- spec/test.add.digest
-- spec/test.add.passwd
-- spec/test.delete.digest
-- spec/test.delete.passwd
-- spec/test.original.digest
-- spec/test.original.passwd
-- spec/test.update.digest
-- spec/test.update.passwd
+test_files: []

data/Rakefile

@@ -1,29 +0,0 @@
-# vim: syntax=ruby
-load 'tasks/this.rb'
-
-This.name     = "htauth"
-This.author   = "Jeremy Hinegardner"
-This.email    = "jeremy@copiousfreetime.org"
-This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
-
-This.ruby_gemspec do |spec|
-  spec.add_dependency( 'bcrypt', '~> 3.1' )
-  spec.add_dependency( 'base64', '~> 0.2' )
-
-  spec.add_development_dependency( 'argon2'   , '~> 2.3')
-  spec.add_development_dependency( 'rake'     , '~> 13.1')
-  spec.add_development_dependency( 'minitest' , '~> 5.21' )
-  spec.add_development_dependency( 'minitest-junit' , '~> 1.1' )
-  spec.add_development_dependency( 'rdoc'     , '~> 6.6' )
-  spec.add_development_dependency( 'simplecov', '~> 0.21' )
-
-  spec.metadata = {
-    "bug_tracker_uri" => "https://github.com/copiousfreetime/htauth/issues",
-    "changelog_uri"   => "https://github.com/copiousfreetime/htauth/blob/master/HISTORY.md",
-    "homepage_uri"    => "https://github.com/copiousfreetime/htauth",
-    "source_code_uri" => "https://github.com/copiousfreetime/htauth",
-  }
-  spec.license = "MIT"
-end
-
-load 'tasks/default.rake'

data/bin/htdigest-ruby

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'htauth/cli/digest'
-rescue LoadError 
-  path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-  raise if $:.include?(path)
-  $: << path
-  retry
-end
-
-HTAuth::CLI::Digest.new.run(ARGV, ENV)

data/bin/htpasswd-ruby

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-
-begin
-  require 'htauth/cli/passwd'
-rescue LoadError 
-  path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-  raise if $:.include?(path)
-  $: << path
-  retry
-end
-
-HTAuth::CLI::Passwd.new.run(ARGV, ENV)

data/spec/algorithm_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe HTAuth::Algorithm do
-  it "raises an error if it encouners an unknown algorithm" do
-    _ { HTAuth::Algorithm.algorithm_from_name("unknown") }.must_raise(::HTAuth::InvalidAlgorithmError)
-  end
-end

data/spec/argon2_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-require 'argon2'
-
-describe HTAuth::Argon2 do
-
-  it "decodes the hash back to the original options" do
-    hash    = '$argon2id$v=19$m=65536,t=3,p=4$V1ln1M4o1RS7SzWHAtqyWQ$jEHi1Qo2FSBgLAPpOa1mPx6OD/twtjj8M1AlVZwamPg'
-    options = HTAuth::Argon2.extract_options_from_existing_password_field(hash)
-    _(options).must_equal ::Argon2::Profiles[:rfc_9106_low_memory]
-  end
-
-  it "encrypts the same way that argon2 does by default" do
-    argon2 = HTAuth::Argon2.new
-    hash   = argon2.encode("a secret")
-    _(::Argon2::Password.verify_password('a secret', hash)).must_equal true
-  end
-
-  it "allow changing the parameters directly" do
-    hash    = '$argon2id$v=19$m=262144,t=3,p=4$7DRAuE1yIHPHqISmcyaJTg$M0EErpbxqv8dvrMrQMoGDEA7KQCw67jGdXwtCbRINFs'
-    options = HTAuth::Argon2.extract_options_from_existing_password_field(hash)
-
-    options[:m_cost] = 11
-
-    argon2     = HTAuth::Argon2.new(options)
-    local_hash = argon2.encode("a secret")
-    _(::Argon2::Password.verify_password('a secret', local_hash)).must_equal true
-  end
-end

data/spec/bcrypt_spec.rb

@@ -1,32 +0,0 @@
-require 'spec_helper'
-
-describe HTAuth::Bcrypt do
-  it "encrypts the same way that apache does by default" do
-    apache_hash = '$2y$05$X7XeXxp0uAO92AGG2P4/fu0mj7MrRDQnlBTkwZLd9rKiH2OUBb9/K'
-    reparsed    = ::BCrypt::Password.new(apache_hash)
-    cost        = reparsed.cost
-
-    _(cost).must_equal HTAuth::Bcrypt::DEFAULT_APACHE_COST
-    _(reparsed.is_password?("a secret")).must_equal true
-
-    bcrypt      = HTAuth::Bcrypt.new(:cost => cost)
-    local_hash  = bcrypt.encode("a secret")
-
-    _(local_hash.is_password?("a secret")).must_equal true
-    _(local_hash.cost).must_equal cost
-  end
-
-  it "encrypts the same way that apache does with different cost" do
-    apache_hash = '$2y$12$O3mBah33UilOkwXrS0kXuOPFBKLBCIp7V.AVvEZQcbnAM5SJLQnfq'
-    reparsed    = ::BCrypt::Password.new(apache_hash)
-    cost        = reparsed.cost
-
-    _(reparsed.is_password?("a secret")).must_equal true
-
-    bcrypt      = HTAuth::Bcrypt.new(:cost => cost)
-    local_hash  = bcrypt.encode("a secret")
-
-    _(local_hash.is_password?("a secret")).must_equal true
-    _(local_hash.cost).must_equal cost
-  end
-end

data/spec/cli/digest_spec.rb

@@ -1,149 +0,0 @@
-require 'spec_helper'
-require 'htauth/cli/digest'
-require 'tempfile'
-
-describe HTAuth::CLI::Digest do
-
-  before(:each) do
-
-    # existing 
-    @tf = Tempfile.new("rpasswrd-digest-test")
-    @tf.write(IO.read(DIGEST_ORIGINAL_TEST_FILE))
-    @tf.close
-    @rdigest = HTAuth::CLI::Digest.new
-
-    # new file
-    @new_file = File.join(File.dirname(@tf.path), "new-testfile")
-
-    # rework stdout and stderr
-    @stdout = ConsoleIO.new
-    @old_stdout = $stdout
-    $stdout = @stdout
-
-    @stderr = ConsoleIO.new
-    @old_stderr = $stderr
-    $stderr = @stderr
-
-    @stdin = ConsoleIO.new
-    @old_stdin = $stdin
-    $stdin = @stdin
-  end
-
-  after(:each) do
-    @tf.close(true)
-    $stderr = @old_stderr
-    $stdout = @old_stdout
-    $stdin = @old_stdin
-    File.unlink(@new_file) if File.exist?(@new_file)
-  end
-
-  it "displays help appropriately" do
-    begin
-      @rdigest.run([ "-h" ])
-    rescue SystemExit => se
-      _(se.status).must_equal 1
-      _(@stdout.string).must_match( /passwordfile realm username/m )
-    end
-  end
-
-  it "displays the version appropriately" do
-    begin
-      @rdigest.run([ "--version" ])
-    rescue SystemExit => se
-      _(se.status).must_equal 1
-      _(@stdout.string).must_match( /version #{HTAuth::VERSION}/ )
-    end
-  end
-
-  it "creates a new file with one entries" do
-    begin
-      @stdin.puts "b secret"
-      @stdin.puts "b secret"
-      @stdin.rewind
-      @rdigest.run([ "-c", @new_file, "htauth", "bob" ])
-    rescue SystemExit => se
-      _(se.status).must_equal 0
-      _(IO.read(@new_file)).must_equal IO.readlines(DIGEST_ORIGINAL_TEST_FILE).first
-    end
-  end
-
-  it "truncates an exiting file if told to create a new file" do
-    begin
-      @stdin.puts "b secret"
-      @stdin.puts "b secret"
-      @stdin.rewind
-      @rdigest.run([ "-c", @tf.path, "htauth", "bob"])
-    rescue SystemExit => se
-      _(se.status).must_equal 0
-      _(IO.read(@tf.path)).must_equal IO.read(DIGEST_DELETE_TEST_FILE)
-    end
-  end
-
-  it "adds an entry to an existing file" do
-    begin
-      @stdin.puts "c secret"
-      @stdin.puts "c secret"
-      @stdin.rewind
-      @rdigest.run([ @tf.path, "htauth-new", "charlie" ])
-    rescue SystemExit => se
-      _(se.status).must_equal 0
-      _(IO.read(@tf.path)).must_equal IO.read(DIGEST_ADD_TEST_FILE)
-    end
-  end
-
-  it "updates an entry in an existing file" do
-    begin
-      @stdin.puts "a new secret"
-      @stdin.puts "a new secret"
-      @stdin.rewind
-      @rdigest.run([ @tf.path, "htauth", "alice" ])
-    rescue SystemExit => se
-      _(@stderr.string).must_equal ""
-      _(se.status).must_equal 0
-      _(IO.read(@tf.path)).must_equal IO.read(DIGEST_UPDATE_TEST_FILE)
-    end
-  end
-
-  it "deletes an entry in an existing file" do
-    begin
-      @rdigest.run([ "-d", @tf.path, "htauth", "alice" ])
-    rescue SystemExit => se
-      _(@stderr.string).must_equal ""
-      _(se.status).must_equal 0
-      _(IO.read(@tf.path)).must_equal IO.read(DIGEST_DELETE_TEST_FILE)
-    end
-  end
-
-  it "has an error if it does not have permissions on the file" do
-    begin
-      @stdin.puts "a secret"
-      @stdin.puts "a secret"
-      @stdin.rewind
-      @rdigest.run([ "-c", "/etc/you-cannot-create-me", "htauth", "alice"])
-    rescue SystemExit => se
-      _(@stderr.string).must_match( %r{Could not open password file /etc/you-cannot-create-me}m )
-      _(se.status).must_equal 1
-    end
-  end
-
-  it "has an error if the input passwords do not match" do
-    begin
-      @stdin.puts "a secret"
-      @stdin.puts "a bad secret"
-      @stdin.rewind
-      @rdigest.run([ @tf.path, "htauth", "alice"])
-    rescue SystemExit => se
-      _(@stderr.string).must_match( /They don't match, sorry./m )
-      _(se.status).must_equal 1
-    end
-  end
-
-  it "has an error if the options are incorrect" do
-    begin
-      @rdigest.run(["--blah"])
-    rescue SystemExit => se
-      _(@stderr.string).must_match( /ERROR:/m )
-      _(se.status).must_equal 1
-    end
-  end
-end