Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > webrick/httpauthライブラリ > WEBrick::HTTPAuthモジュール

module WEBrick::HTTPAuth

クラスの継承リスト: WEBrick::HTTPAuth

Abstract

ユーザ認証の機能を提供するモジュールです。

モジュール関数

basic_auth(req, res, realm) {|user, pass| ... } -> nil

Basic 認証を行うためのメソッドです。

ブロックは user, pass を引数として呼ばれ、 ブロックが true を返すと認証が成功したことになります。 ブロックが false を返すと認証に失敗したとみなし、 例外 WEBrick::HTTPStatus::Unauthorized を投げます。

[PARAM] req:
クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトを指定します。
[PARAM] res:
WEBrick::HTTPResponse オブジェクトを指定します。
[PARAM] realm:
認証のレルムを文字列で指定します。 
srv.mount_proc('/basic_auth') {|req, res|
  HTTPAuth.basic_auth(req, res, "WEBrick's realm") {|user, pass|
    user == 'webrick' && pass == 'supersecretpassword'
  }
  res.body = "hoge"
}
proxy_basic_auth(req, res, realm) {|user, pass| ... } -> nil

プロクシーの Basic 認証行うためのメソッドです。

ブロックは user, pass を引数として呼ばれ、 ブロックが true を返すとユーザを認証したことになります。 ブロックが false を返すと認証に失敗し、例外 WEBrick::HTTPStatus::ProxyAuthenticationRequired を投げます。

[PARAM] req:
クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトを指定します。
[PARAM] res:
WEBrick::HTTPResponse オブジェクトを指定します。
[PARAM] realm:
認証のレルムを文字列で指定します。

Methods

Classes