diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-05-10 23:37:43 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-05-10 23:37:43 +0000 |
commit | 8c2a52937f3b71efa7bcb48e7b8b00bc6b616ab4 (patch) | |
tree | 757bcc2a71bbb2338e5ccc11a0f37e2424132e0c /lib/webrick/httpauth/basicauth.rb | |
parent | 6626b0a2c567669cceebd3bfd0195b0ffd8c97c3 (diff) | |
download | ruby-8c2a52937f3b71efa7bcb48e7b8b00bc6b616ab4.tar.gz |
* lib/webrick: Add documentation for WEBrick::HTTPAuth
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31505 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/webrick/httpauth/basicauth.rb')
-rw-r--r-- | lib/webrick/httpauth/basicauth.rb | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/lib/webrick/httpauth/basicauth.rb b/lib/webrick/httpauth/basicauth.rb index 210fb00bbe..4c51e53199 100644 --- a/lib/webrick/httpauth/basicauth.rb +++ b/lib/webrick/httpauth/basicauth.rb @@ -13,11 +13,32 @@ require 'webrick/httpauth/authenticator' module WEBrick module HTTPAuth + + ## + # Basic Authentication for WEBrick + # + # Use this class to add basic authentication to a WEBrick servlet. + # + # Here is an example of how to set up a BasicAuth: + # + # config = { :Realm => 'BasicAuth example realm' } + # + # htpasswd = WEBrick::HTTPAuth::Htpasswd.new 'my_password_file' + # htpasswd.set_passwd config[:Realm], 'username', 'password' + # htpasswd.flush + # + # config[:UserDB] = htpasswd + # + # basic_auth = WEBrick::HTTPAuth::BasicAuth.new config + class BasicAuth include Authenticator AuthScheme = "Basic" + ## + # Used by UserDB to create a basic password entry + def self.make_passwd(realm, user, pass) pass ||= "" pass.crypt(Utils::random_string(2)) @@ -25,11 +46,26 @@ module WEBrick attr_reader :realm, :userdb, :logger + ## + # Creates a new BasicAuth instance. + # + # See WEBrick::Config::BasicAuth for default configuration entries + # + # You must supply the following configuration entries: + # + # :Realm:: The name of the realm being protected. + # :UserDB:: A database of usernames and passwords. + # A WEBrick::HTTPAuth::Htpasswd instance should be used. + def initialize(config, default=Config::BasicAuth) check_init(config) @config = default.dup.update(config) end + ## + # Authenticates a +req+ and returns a 401 Unauthorized using +res+ if + # the authentication was not correct. + def authenticate(req, res) unless basic_credentials = check_scheme(req) challenge(req, res) @@ -52,12 +88,19 @@ module WEBrick req.user = userid end + ## + # Returns a challenge response which asks for for authentication + # information + def challenge(req, res) res[@response_field] = "#{@auth_scheme} realm=\"#{@realm}\"" raise @auth_exception end end + ## + # Basic authentication for proxy servers. See BasicAuth for details. + class ProxyBasicAuth < BasicAuth include ProxyAuthenticator end |