Class: WEBrick::HTTPAuth::Htpasswd
- Inherits:
-
Object
- Object
- WEBrick::HTTPAuth::Htpasswd
- Includes:
- UserDB
- 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 WEBrick::HTTPAuth::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
Instance Attribute Summary
Attributes included from UserDB
Instance Method Summary collapse
-
#delete_passwd(realm, user) ⇒ Object
Removes a password from the database for
user
inrealm
. -
#each ⇒ Object
Iterate passwords in the database.
-
#flush(output = nil) ⇒ Object
Flush the password database.
-
#get_passwd(realm, user, reload_db) ⇒ Object
Retrieves a password from the database for
user
inrealm
. -
#initialize(path) ⇒ Htpasswd
constructor
Open a password database at
path
. -
#reload ⇒ Object
Reload passwords from the database.
-
#set_passwd(realm, user, pass) ⇒ Object
Sets a password in the database for
user
inrealm
topass
.
Methods included from UserDB
Constructor Details
Instance Method Details
#delete_passwd(realm, user) ⇒ Object
Removes a password from the database for user
in realm
.
107 108 109 |
# File 'lib/webrick/httpauth/htpasswd.rb', line 107 def delete_passwd(realm, user) @passwd.delete(user) end |
#each ⇒ Object
Iterate passwords in the database.
114 115 116 117 118 |
# File 'lib/webrick/httpauth/htpasswd.rb', line 114 def each # :yields: [user, password] @passwd.keys.sort.each{|user| yield([user, @passwd[user]]) } end |
#flush(output = nil) ⇒ Object
Flush the password database. If output
is given the database will be written there instead of to the original path.
76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/webrick/httpauth/htpasswd.rb', line 76 def flush(output=nil) output ||= @path tmp = Tempfile.new("htpasswd", File::dirname(output)) begin each{|item| tmp.puts(item.join(":")) } tmp.close File::rename(tmp.path, output) rescue tmp.close(true) end end |
#get_passwd(realm, user, reload_db) ⇒ Object
Retrieves a password from the database for user
in realm
. If reload_db
is true the database will be reloaded first.
92 93 94 95 |
# File 'lib/webrick/httpauth/htpasswd.rb', line 92 def get_passwd(realm, user, reload_db) reload() if reload_db @passwd[user] end |
#reload ⇒ Object
Reload passwords from the database
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/webrick/httpauth/htpasswd.rb', line 49 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) ⇒ Object
Sets a password in the database for user
in realm
to pass
.
100 101 102 |
# File 'lib/webrick/httpauth/htpasswd.rb', line 100 def set_passwd(realm, user, pass) @passwd[user] = make_passwd(realm, user, pass) end |