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

class WEBrick::HTTPAuth::BasicAuth

クラス・モジュールの継承リスト: WEBrick::HTTPAuth::BasicAuth < WEBrick::HTTPAuth::Authenticator < Object < Kernel < BasicObject

要約

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

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

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

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

特異メソッド

定義 説明
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__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap then to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE ::AuthException ::AuthScheme ::RequestField ::ResponseField ::ResponseInfoField