htauth 2.2.0 → 3.0.0

data/lib/htauth/passwd_file.rb

@@ -1,9 +1,11 @@
-require 'stringio'
-require 'tempfile'
+# frozen_string_literal: true
 
-require 'htauth/error'
-require 'htauth/file'
-require 'htauth/passwd_entry'
+require "stringio"
+require "tempfile"
+
+require "htauth/error"
+require "htauth/file"
+require "htauth/passwd_entry"
 
 module HTAuth
   # Public: An API for managing an 'htpasswd' file
@@ -11,13 +13,12 @@ module HTAuth
   # Examples
   #
   #   ::HTAuth::PasswdFile.open("my.passwd") do |pf|
-  #     pf.has_entry?('myuser', 'myrealm')
-  #     pf.add_or_update('someuser', 'myrealm', 'a password')
-  #     pf.delete('someolduser', 'myotherrealm')
+  #     pf.has_entry?('myuser')
+  #     pf.add_or_update('someuser', 'a password')
+  #     pf.delete('someolduser')
   #   end
   #
   class PasswdFile < HTAuth::File
-
     # Private: The class implementing a single entry in the PasswdFile
     ENTRY_KLASS = HTAuth::PasswdEntry
 
@@ -33,7 +34,7 @@ module HTAuth
     # Returns true or false if the username
     def has_entry?(username)
       test_entry = PasswdEntry.new(username)
-      @entries.has_key?(test_entry.key)
+      @entries.key?(test_entry.key)
     end
 
     # Public: remove the given username from the file
@@ -48,10 +49,10 @@ module HTAuth
     #
     # Returns nothing
     def delete(username)
-      if has_entry?(username) then 
+      if has_entry?(username)
         ir = internal_record(username)
-        line_index = ir['line_index']
-        @entries.delete(ir['entry'].key)
+        line_index = ir["line_index"]
+        @entries.delete(ir["entry"].key)
         @lines[line_index] = nil
         dirty!
       end
@@ -59,7 +60,7 @@ module HTAuth
     end
 
     # Public: Add or update the username entry with the new password and
-    # algorithm. This will add a new entry if the username does not exist in 
+    # algorithm. This will add a new entry if the username does not exist in
     # the file. If the entry does exist in the file, then the password
     # of the entry is updated to the new password / algorithm
     #
@@ -68,7 +69,7 @@ module HTAuth
     # username  - the username of the entry
     # password  - the password of the entry
     # algorithm - the algorithm to use (default: "md5"). Valid options are:
-    #             "md5", "bcrypt", "sha1", "plaintext", or "crypt"
+    #             "md5", "bcrypt", "argon2", "sha1", "plaintext", or "crypt"
     # algorithm_args - key-value pairs of arguments that are passed to the
     #                  algorithm, currently this is only used to pass the cost
     #                  to the bcrypt algorithm
@@ -84,7 +85,7 @@ module HTAuth
     #
     # Returns nothing.
     def add_or_update(username, password, algorithm = Algorithm::DEFAULT, algorithm_args = {})
-      if has_entry?(username) then
+      if has_entry?(username)
         update(username, password, algorithm, algorithm_args)
       else
         add(username, password, algorithm, algorithm_args)
@@ -96,7 +97,7 @@ module HTAuth
     # username  - the username of the entry
     # password  - the password of the entry
     # algorithm - the algorithm to use (default: "md5"). Valid options are:
-    #             "md5", "bcrypt", "sha1", "plaintext", or "crypt"
+    #             "md5", "bcrypt", "argon2", "sha1", "plaintext", or "crypt"
     # algorithm_args - key-value pairs of arguments that are passed to the
     #                  algorithm, currently this is only used to pass the cost
     #                  to the bcrypt algorithm
@@ -116,12 +117,13 @@ module HTAuth
     # Raises PasswdFileError if the give username already exists.
     def add(username, password, algorithm = Algorithm::DEFAULT, algorithm_args = {})
       raise PasswdFileError, "Unable to add already existing user #{username}" if has_entry?(username)
+
       new_entry = PasswdEntry.new(username, password, algorithm, algorithm_args)
       new_index = @lines.size
       @lines << new_entry.to_s
-      @entries[new_entry.key] = { 'entry' => new_entry, 'line_index' => new_index }
+      @entries[new_entry.key] = { "entry" => new_entry, "line_index" => new_index }
       dirty!
-      return nil
+      nil
     end
 
     # Public: Update an existing record in the file.
@@ -133,7 +135,7 @@ module HTAuth
     # username  - the username of the entry
     # password  - the password of the entry
     # algorithm - the algorithm to use (default: "existing"). Valid options are:
-    #             "existing", "md5", "bcrypt", "sha1", "plaintext", or "crypt"
+    #             "existing", "md5", "bcrypt", "argon2", "sha1", "plaintext", or "crypt"
     # algorithm_args - key-value pairs of arguments that are passed to the
     #                  algorithm, currently this is only used to pass the cost
     #                  to the bcrypt algorithm
@@ -153,13 +155,14 @@ module HTAuth
     # Raises PasswdFileError if the give username does not exist.
     def update(username, password, algorithm = Algorithm::EXISTING, algorithm_args = {})
       raise PasswdFileError, "Unable to update non-existent user #{username}" unless has_entry?(username)
+
       ir = internal_record(username)
-      ir['entry'].algorithm = algorithm
-      ir['entry'].algorithm_args = algorithm_args.dup
-      ir['entry'].password = password
-      @lines[ir['line_index']] = ir['entry'].to_s
+      ir["entry"].algorithm = algorithm
+      ir["entry"].algorithm_args = algorithm_args.dup
+      ir["entry"].password = password
+      @lines[ir["line_index"]] = ir["entry"].to_s
       dirty!
-      return nil
+      nil
     end
 
     # Public: Returns a copy of then given PasswdEntry from the file.
@@ -177,8 +180,9 @@ module HTAuth
     # Returns nil if the entry is not found
     def fetch(username)
       return nil unless has_entry?(username)
+
       ir = internal_record(username)
-      return ir['entry'].dup
+      ir["entry"].dup
     end
 
     # Public: authenticates the password of a given username
@@ -194,8 +198,9 @@ module HTAuth
     # Raises PasswordFileErrorif the given username does not exist
     def authenticated?(username, password)
       raise PasswdFileError, "Unable to authenticate a non-existent user #{username}" unless has_entry?(username)
+
       ir = internal_record(username)
-      return ir['entry'].authenticated?(password)
+      ir["entry"].authenticated?(password)
     end
 
     # Internal: returns the class used for each entry

data/lib/htauth/plaintext.rb

@@ -1,25 +1,27 @@
-require 'htauth/algorithm'
+# frozen_string_literal: true
+
+require "htauth/algorithm"
 
 module HTAuth
   # Internal: the plaintext algorithm, which does absolutly nothing
   class Plaintext < Algorithm
-
     ENTRY_REGEX = /\A[^$:]*\Z/
 
     def self.entry_matches?(entry)
       ENTRY_REGEX.match?(entry)
     end
 
-    def self.handles?(password_entry)
+    def self.handles?(_password_entry)
       false
     end
 
     # ignore parameters
-    def initialize(params = {})
+    def initialize(_params = {})
+      super()
     end
 
     def encode(password)
-      "#{password}"
+      password.to_s
     end
   end
 end

data/lib/htauth/sha1.rb

@@ -1,22 +1,24 @@
-require 'htauth/algorithm'
-require 'digest/sha1'
-require 'base64'
+# frozen_string_literal: true
+
+require "htauth/algorithm"
+require "digest/sha1"
+require "base64"
 
 module HTAuth
   # Internal: an implementation of the SHA based encoding algorithm
   # as used in the apache htpasswd -s option
   #
   class Sha1 < Algorithm
-
-    PREFIX      = '{SHA}'.freeze
-    ENTRY_REGEX = %r[\A#{Regexp.escape(PREFIX)}[A-Za-z0-9+\/=]{28}\z].freeze
+    PREFIX      = "{SHA}"
+    ENTRY_REGEX = %r[\A#{Regexp.escape(PREFIX)}[A-Za-z0-9+/=]{28}\z]
 
     def self.handles?(password_entry)
       ENTRY_REGEX.match?(password_entry)
     end
 
     # ignore the params
-    def initialize(params = {}) 
+    def initialize(_params = {})
+      super()
     end
 
     def encode(password)

data/lib/htauth/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module HTAuth
   # Public: The version of the htauth library
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 end

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/console'
-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.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeremy Hinegardner
-autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2026-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -25,78 +24,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-- !ruby/object:Gem::Dependency
-  name: minitest-junit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.4'
-  type: :development
+        version: '0.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-  type: :development
+        version: '0.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-description: HTAuth is a pure ruby replacement for the Apache support programs htdigest
-  and htpasswd.  Command line and API access are provided for access to htdigest and
-  htpasswd files.
+        version: '0.6'
+description: HTAuth provides an API and commandline tools for managing Apache/httpd
+  style htpasswd and htdigest files.
 email: jeremy@copiousfreetime.org
 executables:
 - htdigest-ruby
@@ -105,19 +61,21 @@ 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
 - lib/htauth/bcrypt.rb
 - lib/htauth/cli.rb
 - lib/htauth/cli/digest.rb
@@ -136,29 +94,6 @@ files:
 - lib/htauth/plaintext.rb
 - lib/htauth/sha1.rb
 - lib/htauth/version.rb
-- spec/algorithm_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
@@ -167,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
@@ -179,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.4.6
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
-summary: HTAuth is a pure ruby replacement for the Apache support programs htdigest
-  and htpasswd.  Command line and API access are provided for access to htdigest and
-  htpasswd files.
-test_files:
-- spec/algorithm_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
+summary: HTAuth provides an API and commandline tools for managing Apache/httpd style
+  htpasswd and htdigest files.
+test_files: []

data/Rakefile

@@ -1,27 +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_development_dependency( 'rake'     , '~> 13.0')
-  spec.add_development_dependency( 'minitest' , '~> 5.11' )
-  spec.add_development_dependency( 'minitest-junit' , '~> 1.0' )
-  spec.add_development_dependency( 'rdoc'     , '~> 6.4' )
-  spec.add_development_dependency( 'simplecov', '~> 0.17' )
-
-  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'
-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'
-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,8 +0,0 @@
-require 'spec_helper'
-require 'htauth/algorithm'
-
-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/bcrypt_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-require 'htauth/bcrypt'
-
-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