2015-12-16 00:07:31 -05:00
|
|
|
# frozen_string_literal: false
|
2003-07-23 12:51:36 -04:00
|
|
|
#
|
|
|
|
# httpauth/htdigest.rb -- Apache compatible htdigest file
|
|
|
|
#
|
|
|
|
# Author: IPR -- Internet Programming with Ruby -- writers
|
|
|
|
# Copyright (c) 2003 Internet Programming with Ruby writers. All rights
|
|
|
|
# reserved.
|
|
|
|
#
|
|
|
|
# $IPR: htdigest.rb,v 1.4 2003/07/22 19:20:45 gotoyuzo Exp $
|
|
|
|
|
|
|
|
require 'webrick/httpauth/userdb'
|
|
|
|
require 'webrick/httpauth/digestauth'
|
|
|
|
require 'tempfile'
|
|
|
|
|
|
|
|
module WEBrick
|
|
|
|
module HTTPAuth
|
2011-05-10 19:37:43 -04:00
|
|
|
|
|
|
|
##
|
|
|
|
# Htdigest accesses apache-compatible digest password files. Passwords are
|
|
|
|
# matched to a realm where they are valid. For security, the path for a
|
|
|
|
# digest password database should be stored outside of the paths available
|
|
|
|
# to the HTTP server.
|
|
|
|
#
|
|
|
|
# Htdigest is intended for use with WEBrick::HTTPAuth::DigestAuth and
|
|
|
|
# stores passwords using cryptographic hashes.
|
|
|
|
#
|
|
|
|
# htpasswd = WEBrick::HTTPAuth::Htdigest.new 'my_password_file'
|
|
|
|
# htpasswd.set_passwd 'my realm', 'username', 'password'
|
|
|
|
# htpasswd.flush
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
class Htdigest
|
|
|
|
include UserDB
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Open a digest password database at +path+
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
def initialize(path)
|
|
|
|
@path = path
|
|
|
|
@mtime = Time.at(0)
|
|
|
|
@digest = Hash.new
|
2016-08-30 02:22:30 -04:00
|
|
|
@mutex = Thread::Mutex::new
|
2003-07-23 12:51:36 -04:00
|
|
|
@auth_type = DigestAuth
|
2017-12-21 20:07:39 -05:00
|
|
|
File.open(@path,"a").close unless File.exist?(@path)
|
2003-07-23 12:51:36 -04:00
|
|
|
reload
|
|
|
|
end
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Reloads passwords from the database
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
def reload
|
|
|
|
mtime = File::mtime(@path)
|
|
|
|
if mtime > @mtime
|
|
|
|
@digest.clear
|
2017-12-21 20:07:39 -05:00
|
|
|
File.open(@path){|io|
|
2003-07-23 12:51:36 -04:00
|
|
|
while line = io.gets
|
|
|
|
line.chomp!
|
|
|
|
user, realm, pass = line.split(/:/, 3)
|
|
|
|
unless @digest[realm]
|
|
|
|
@digest[realm] = Hash.new
|
|
|
|
end
|
|
|
|
@digest[realm][user] = pass
|
|
|
|
end
|
|
|
|
}
|
|
|
|
@mtime = mtime
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Flush the password database. If +output+ is given the database will
|
|
|
|
# be written there instead of to the original path.
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
def flush(output=nil)
|
|
|
|
output ||= @path
|
2013-04-20 11:10:29 -04:00
|
|
|
tmp = Tempfile.create("htpasswd", File::dirname(output))
|
|
|
|
renamed = false
|
2003-07-23 12:51:36 -04:00
|
|
|
begin
|
|
|
|
each{|item| tmp.puts(item.join(":")) }
|
|
|
|
tmp.close
|
|
|
|
File::rename(tmp.path, output)
|
2013-04-20 11:10:29 -04:00
|
|
|
renamed = true
|
|
|
|
ensure
|
2016-11-21 18:05:41 -05:00
|
|
|
tmp.close
|
2013-04-20 11:10:29 -04:00
|
|
|
File.unlink(tmp.path) if !renamed
|
2003-07-23 12:51:36 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Retrieves a password from the database for +user+ in +realm+. If
|
|
|
|
# +reload_db+ is true the database will be reloaded first.
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
def get_passwd(realm, user, reload_db)
|
|
|
|
reload() if reload_db
|
|
|
|
if hash = @digest[realm]
|
|
|
|
hash[user]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Sets a password in the database for +user+ in +realm+ to +pass+.
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
def set_passwd(realm, user, pass)
|
|
|
|
@mutex.synchronize{
|
|
|
|
unless @digest[realm]
|
|
|
|
@digest[realm] = Hash.new
|
|
|
|
end
|
|
|
|
@digest[realm][user] = make_passwd(realm, user, pass)
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Removes a password from the database for +user+ in +realm+.
|
|
|
|
|
2003-07-23 12:51:36 -04:00
|
|
|
def delete_passwd(realm, user)
|
|
|
|
if hash = @digest[realm]
|
|
|
|
hash.delete(user)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2011-05-10 19:37:43 -04:00
|
|
|
##
|
|
|
|
# Iterate passwords in the database.
|
|
|
|
|
|
|
|
def each # :yields: [user, realm, password_hash]
|
2003-07-23 12:51:36 -04:00
|
|
|
@digest.keys.sort.each{|realm|
|
|
|
|
hash = @digest[realm]
|
|
|
|
hash.keys.sort.each{|user|
|
|
|
|
yield([user, realm, hash[user]])
|
|
|
|
}
|
|
|
|
}
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|