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

class WEBrick::HTTPAuth::BasicAuth

クラスの継承リスト: WEBrick::HTTPAuth::BasicAuth < WEBrick::HTTPAuth::Authenticator < Object < Kernel < BasicObject

要約

HTTP の Basic 認証のためのクラスです。

例

realm = "WEBrick's realm"
srv = HTTPServer.new({ :BindAddress => '127.0.0.1', :Port => 10080})

htpd = HTTPAuth::Htpasswd.new('dot.htpasswd')
htpd.set_passwd(nil, 'username', 'supersecretpass')

authenticator = HTTPAuth::BasicAuth.new(:UserDB => htpd, :Realm => realm)
srv.mount_proc('/basic_auth') {|req, res|
  authenticator.authenticate(req, res)
  res.body = "hoge"
}

特異メソッド

定義	説明
`make_passwd(realm, user, pass) -> String`	pass をランダムなソルトで crypt した文字列を返します。
`new(config, default = Config::BasicAuth) -> WEBrick::HTTPAuth::BasicAuth`	BasicAuth オブジェクトを生成します。config は設定を保存したハッシュです。

インスタンスメソッド

定義	説明
`authenticate(request, response) -> bool`	クライアントから送られてきたユーザ名とパスワードを認証します。認証に失敗した場合は challenge を呼びます。
`challenge(request, response) -> ()`	クライアントにパスワードを要求するためにレスポンスに WWW-Authenticate ヘッダを設定し、例外 WEBrick::HTTPStatus::Unauthorized を投げます。
`logger -> object`	ロガーオブジェクトを返します。
`realm -> String`	realm を文字列で返します。
`userdb -> WEBrick::HTTPAuth::Htpasswd`	ユーザ名とパスワードを保存した WEBrick::HTTPAuth::Htpasswd オブジェクトを返します。

継承したメソッド

! != == === =~ __id__ __send__ _dump class clone dclone display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? marshal_dump marshal_load method method_missing methods must_be must_be_close_to must_be_empty must_be_instance_of must_be_kind_of must_be_nil must_be_same_as must_be_within_epsilon must_equal must_include must_match must_raise must_respond_to must_send must_throw nil? pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods public_methods remove_instance_variable respond_to? respond_to_missing? singleton_class singleton_method_added singleton_method_removed singleton_method_undefined singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str to_yaml to_yaml_properties to_yaml_style trust untaint untrust untrusted? wont_be wont_be_close_to wont_be_empty wont_be_instance_of wont_be_kind_of wont_be_nil wont_be_same_as wont_be_within_epsilon wont_equal wont_include wont_match wont_respond_to ::AuthException ::AuthScheme ::RequestField ::ResponseField ::ResponseInfoField