Class: WEBrick::HTTPAuth::Htpasswd
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
UserDB
|
|
Inherits: | Object |
Defined in: | lib/webrick/httpauth/htpasswd.rb |
Overview
Htpasswd
accesses apache-compatible password files. Passwords are matched to a realm where they are valid. For security, the path for a password database should be stored outside of the paths available to the HTTP server.
Htpasswd
is intended for use with BasicAuth.
To create an Htpasswd
database with a single user:
htpasswd = WEBrick::HTTPAuth::Htpasswd.new 'my_password_file'
htpasswd.set_passwd 'my realm', 'username', 'password'
htpasswd.flush
Class Method Summary
-
.new(path) ⇒ Htpasswd
constructor
Open a password database at
path
Instance Attribute Summary
UserDB - Included
#auth_type | The authentication type. |
Instance Method Summary
-
#delete_passwd(realm, user)
Removes a password from the database for
user
inrealm
. -
#each
Iterate passwords in the database.
-
#flush(output = nil)
Flush the password database.
-
#get_passwd(realm, user, reload_db)
Retrieves a password from the database for
user
inrealm
. -
#reload
Reload passwords from the database.
-
#set_passwd(realm, user, pass)
Sets a password in the database for
user
inrealm
topass
.
UserDB - Included
#get_passwd | Retrieves a password in |
#make_passwd | Creates an obscured password in |
#set_passwd | Sets a password in |
Constructor Details
.new(path) ⇒ Htpasswd
Open a password database at path
Instance Method Details
#delete_passwd(realm, user)
Removes a password from the database for user
in realm
.
# File 'lib/webrick/httpauth/htpasswd.rb', line 111
def delete_passwd(realm, user) @passwd.delete(user) end
#each
Iterate passwords in the database.
# File 'lib/webrick/httpauth/htpasswd.rb', line 118
def each # :yields: [user, password] @passwd.keys.sort.each{|user| yield([user, @passwd[user]]) } end
#flush(output = nil)
Flush the password database. If output
is given the database will be written there instead of to the original path.
# File 'lib/webrick/httpauth/htpasswd.rb', line 77
def flush(output=nil) output ||= @path tmp = Tempfile.create("htpasswd", File::dirname(output)) renamed = false begin each{|item| tmp.puts(item.join(":")) } tmp.close File::rename(tmp.path, output) renamed = true ensure tmp.close if !tmp.closed? File.unlink(tmp.path) if !renamed end end
#get_passwd(realm, user, reload_db)
Retrieves a password from the database for user
in realm
. If reload_db
is true the database will be reloaded first.
# File 'lib/webrick/httpauth/htpasswd.rb', line 96
def get_passwd(realm, user, reload_db) reload() if reload_db @passwd[user] end
#reload
Reload passwords from the database
# File 'lib/webrick/httpauth/htpasswd.rb', line 50
def reload mtime = File::mtime(@path) if mtime > @mtime @passwd.clear open(@path){|io| while line = io.gets line.chomp! case line when %r!\A[^:]+:[a-zA-Z0-9./]{13}\z! user, pass = line.split(":") when /:\$/, /:{SHA}/ raise NotImplementedError, 'MD5, SHA1 .htpasswd file not supported' else raise StandardError, 'bad .htpasswd file' end @passwd[user] = pass end } @mtime = mtime end end
#set_passwd(realm, user, pass)
Sets a password in the database for user
in realm
to pass
.
# File 'lib/webrick/httpauth/htpasswd.rb', line 104
def set_passwd(realm, user, pass) @passwd[user] = make_passwd(realm, user, pass) end