Type:
Module

HTTPAuth provides both basic and digest authentication.

To enable authentication for requests in WEBrick you will need a user database and an authenticator. To start, here's an Htpasswd database for use with a DigestAuth authenticator:

config = { :Realm => 'DigestAuth example realm' }

htpasswd = WEBrick::HTTPAuth::Htpasswd.new 'my_password_file'
htpasswd.auth_type = WEBrick::HTTPAuth::DigestAuth
htpasswd.set_passwd config[:Realm], 'username', 'password'
htpasswd.flush

The :Realm is used to provide different access to different groups across several resources on a server. Typically you'll need only one realm for a server.

This database can be used to create an authenticator:

config[:UserDB] = htpasswd

digest_auth = WEBrick::HTTPAuth::DigestAuth.new config

To authenticate a request call authenticate with a request and response object in a servlet:

def do_GET req, res
  @authenticator.authenticate req, res
end

For digest authentication the authenticator must not be created every request, it must be passed in as an option via WEBrick::HTTPServer#mount.

flush
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htgroup

flush(output=nil) Instance Public methods Flush the group database. If output

2025-01-10 15:47:30
flush
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htpasswd

flush(output=nil) Instance Public methods Flush the password database. If output

2025-01-10 15:47:30
challenge
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::DigestAuth

challenge(req, res, stale=false) Instance Public methods Returns a challenge

2025-01-10 15:47:30
delete_passwd
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htpasswd

delete_passwd(realm, user) Instance Public methods Removes a password from the

2025-01-10 15:47:30
make_passwd
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::UserDB

make_passwd(realm, user, pass) Instance Public methods Creates an obscured password

2025-01-10 15:47:30
reload
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htgroup

reload() Instance Public methods Reload groups from the database

2025-01-10 15:47:30
authenticate
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::DigestAuth

authenticate(req, res) Instance Public methods Authenticates a req

2025-01-10 15:47:30
each
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htdigest

each() Instance Public methods Iterate passwords in the database.

2025-01-10 15:47:30
get_passwd
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htdigest

get_passwd(realm, user, reload_db) Instance Public methods Retrieves a password

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/WEBrick/WEBrick::HTTPAuth/WEBrick::HTTPAuth::Htpasswd

new(path) Class Public methods Open a password database at path

2025-01-10 15:47:30