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

class WEBrick::HTTPAuth::Htdigest

クラスの継承リスト: WEBrick::HTTPAuth::Htdigest < WEBrick::HTTPAuth::UserDB < Object < Kernel < BasicObject

要約

Apache の htdigest 互換のクラス。

require 'webrick'
include WEBrick
htd = HTTPAuth::Htdigest.new('dot.htdigest')
htd.set_passwd('realm', 'username', 'supersecretpass')
htd.flush
htd2 = HTTPAuth::Htdigest.new('dot.htdigest')
p htd2.get_passwd('realm', 'username', false) == '65fe03e5b0a199462186848cc7fda42b'

目次

特異メソッド
new
インスタンスメソッド
delete_passwd each flush get_passwd reload set_passwd

特異メソッド

new(path) -> WEBrick::HTTPAuth::Htdigest[permalink][rdoc]

Htdigest オブジェクトを生成します。

[PARAM] path:
パスワードを保存するファイルのパスを与えます。

インスタンスメソッド

delete_passwd(realm, user)[permalink][rdoc]

realm に属するユーザ user のパスワードを削除します。

[PARAM] realm:
レルムを指定します。
[PARAM] user:
ユーザ名を指定します。
each {|user, realm, pass| ... } -> Hash[permalink][rdoc]

ユーザ名、レルム、パスワードをブロックに渡して評価します。

flush(path = nil) -> ()[permalink][rdoc]

ファイルに書き込みます。ファイル名を与えた場合は、そこに書き込みます。

[PARAM] path:
ファイル名を指定します。
get_passwd(realm, user, reload_db) -> String[permalink][rdoc]

与えられたレルムとユーザ名からパスワードのハッシュ値を取得して返します。

[PARAM] realm:
レルムを指定します。
[PARAM] user:
ユーザ名を指定します。
[PARAM] reload_db:
真を指定すると WEBrick::HTTPAuth::Htdigest#reload を呼んでから値を返します。
reload[permalink][rdoc]

ファイルから再度読み込みます。

set_passwd(realm, user, pass)[permalink][rdoc]

与えられた情報をもとに、パスワードをハッシュ化して保存します。

[PARAM] realm:
レルムを指定します。
[PARAM] user:
ユーザ名を指定します。
[PARAM] pass:
パスワードを指定します。