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

module WEBrick::HTTPAuth

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

要約

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

モジュール関数

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

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

与えられたブロックは user, pass をブロックパラメータとして渡されて評価されます。ブロックの評価結果が真である場合、認証が成功したことになります。ブロックの評価結果が偽である場合、認証は失敗したことになり、例外が発生します。

[PARAM] req:: クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトを指定します。
[PARAM] res:: WEBrick::HTTPResponse オブジェクトを指定します。
[PARAM] realm:: 認証のレルムを文字列で指定します。
[EXCEPTION] WEBrick::HTTPStatus::Unauthorized:: 認証に失敗した場合に発生します。

require 'webrick'
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[permalink][rdoc]

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

[PARAM] req:: クライアントからのリクエストを表す WEBrick::HTTPRequest オブジェクトを指定します。
[PARAM] res:: WEBrick::HTTPResponse オブジェクトを指定します。
[PARAM] realm:: 認証のレルムを文字列で指定します。
[EXCEPTION] WEBrick::HTTPStatus::ProxyAuthenticationRequired:: 認証に失敗した場合に発生します。

module WEBrick::HTTPAuth

要約

目次

モジュール関数