class WEBrick::HTTPAuth::ProxyBasicAuth + WEBrick::HTTPAuth::ProxyAuthenticator + WEBrick::HTTPAuth::BasicAuth
クラスの継承リスト: WEBrick::HTTPAuth::ProxyBasicAuth < WEBrick::HTTPAuth::ProxyAuthenticator < WEBrick::HTTPAuth::BasicAuth < WEBrick::HTTPAuth::Authenticator < Object < Kernel < BasicObject
要約
プロクシの Basic 認証のためのクラスです。
特異メソッド
make_passwd(realm, user, pass) -> String
-
pass をランダムなソルトで crypt した文字列を返します。
- [PARAM] realm:
- レルムを指定します。
- [PARAM] user:
- ユーザ名を指定します。
- [PARAM] pass:
- パスワードを指定します。
new(config, default = Config::BasicAuth) -> WEBrick::HTTPAuth::BasicAuth
-
BasicAuth オブジェクトを生成します。config は設定を保存したハッシュです。
config で有効なハッシュキーは以下の通りです。
:Realm => :UserDB => :Logger => :AutoReloadUserDB =>
realm を表す文字列 :Realm には与えます。:UserDB には WEBrick::HTTPAuth::Htpasswd オブジェクトを与えます。:Logger には ロガーオブジェクトを与えます。また、:AutoReloadUserDB には WEBrick::HTTPAuth::Htpasswd#get_passwd の reload_db に渡す引数を与えます。
- [PARAM] config:
- 設定を保持しているハッシュを指定します。
- [PARAM] default:
- デフォルトは WEBrick::Config::BasicAuth です。
インスタンスメソッド
authenticate(request, response) -> bool
-
クライアントから送られてきたユーザ名とパスワードを認証します。 認証に失敗した場合は challenge を呼びます。
- [PARAM] request:
- WEBrick::HTTPRequest のインスタンスを指定します。
- [PARAM] response:
- WEBrick::HTTPResponse のインスタンスを指定します。
- [EXCEPTION] WEBrick::HTTPStatus::Unauthorized:
- 認証に失敗した場合に発生します。
challenge(request, response) -> ()
-
クライアントにパスワードを要求するためにレスポンスに WWW-Authenticate ヘッダを 設定し、例外 WEBrick::HTTPStatus::Unauthorized を投げます。
- [EXCEPTION] WEBrick::HTTPStatus::Unauthorized:
- このメソッドを呼ぶと必ず発生します。
logger -> object
-
ロガーオブジェクトを返します。
realm -> String
-
realm を文字列で返します。
userdb -> WEBrick::HTTPAuth::Htpasswd
-
ユーザ名とパスワードを保存した WEBrick::HTTPAuth::Htpasswd オブジェクトを返します。
定数
AuthException -> Class
InfoField -> "Proxy-Authentication-Info"
-
キーの名前です。
RequestField -> "Proxy-Authorization"
-
リクエストフィールドのキーの名前です。
ResponseField -> "Proxy-Authenticate"
-
レスポンスフィールドのキーの名前です。