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

class WEBrick::HTTPAuth::DigestAuth

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

要約

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

[RFC2617] も参照してください。

例:

require 'webrick'
config = { :Realm => 'DigestAuth example realm' }

htdigest = WEBrick::HTTPAuth::Htdigest.new 'my_password_file'
htdigest.set_passwd config[:Realm], 'username', 'password'
htdigest.flush

config[:UserDB] = htdigest

digest_auth = WEBrick::HTTPAuth::DigestAuth.new config

サーブレットの initialize メソッドの中でこのクラスのインスタンスを作成しないようにしてください。デフォルトでは WEBrick はリクエストのたびにサーブレットのインスタンスを生成しますが、 WEBrick::HTTPAuth::DigestAuth のオブジェクトはリクエストをまたいで利用しなければならないためです。

特異メソッド

定義 説明
make_passwd(realm, user, pass) -> String

与えられた情報を使用してハッシュ化したパスワードを生成します。

new(config, default = WEBrick::Config::DigestAuth) -> WEBrick::HTTPAuth::DigestAuth

自身を初期化します。

インスタンスメソッド

定義 説明
algorithm -> String

アルゴリズムを表す文字列を返します。

authenticate(request, response) -> true

クライアントから送られてきたユーザ名とパスワードを認証します。認証に失敗した場合は challenge を呼びます。

challenge(request, response, stale = false)

クライアントにパスワードを要求するためにレスポンスに WWW-Authenticate ヘッダを設定し、例外 WEBrick::HTTPStatus::Unauthorized を発生させます。

qop -> String

Qop キーの値を返します。

継承したメソッド

! != __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 logger realm userdb ::AuthException ::AuthScheme ::RequestField ::ResponseField ::ResponseInfoField