In Files

  • webrick/httpauth/htpasswd.rb

WEBrick::HTTPAuth::Htpasswd

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

Public Class Methods

new(path) click to toggle source

Open a password database at path

 
               # File webrick/httpauth/htpasswd.rb, line 37
def initialize(path)
  @path = path
  @mtime = Time.at(0)
  @passwd = Hash.new
  @auth_type = BasicAuth
  open(@path,"a").close unless File::exist?(@path)
  reload
end
            

Public Instance Methods

delete_passwd(realm, user) click to toggle source

Removes a password from the database for user in realm.

 
               # File webrick/httpauth/htpasswd.rb, line 110
def delete_passwd(realm, user)
  @passwd.delete(user)
end
            
each() click to toggle source

Iterate passwords in the database.

 
               # File webrick/httpauth/htpasswd.rb, line 117
def each # :yields: [user, password]
  @passwd.keys.sort.each{|user|
    yield([user, @passwd[user]])
  }
end
            
flush(output=nil) click to toggle source

Flush the password database. If output is given the database will be written there instead of to the original path.

 
               # File webrick/httpauth/htpasswd.rb, line 76
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) click to toggle source

Retrieves a password from the database for user in realm. If reload_db is true the database will be reloaded first.

 
               # File webrick/httpauth/htpasswd.rb, line 95
def get_passwd(realm, user, reload_db)
  reload() if reload_db
  @passwd[user]
end
            
reload() click to toggle source

Reload passwords from the database

 
               # File 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) click to toggle source

Sets a password in the database for user in realm to pass.

 
               # File webrick/httpauth/htpasswd.rb, line 103
def set_passwd(realm, user, pass)
  @passwd[user] = make_passwd(realm, user, pass)
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus