lib/auth.php

CVS Rev. 1.19

pkwk_login($pass = '')

  • $pass が管理者パスワード$adminpass と同じであるかを確認する
    • 同じであればTRUE が、違うとFALSE が返ってくる
    • PukiWiki 1.4.4 で追加されました
      • PukiWiki 1.4.6 でこのファイルに移動

pkwk_hash_compute($phrase = '', $scheme = '{x-php-md5}', $prefix = TRUE, $canonical = FALSE)

  • 「RFC2307および既存のLDAP実装」準拠のパスワードを生成・入力値を判定用に変換する関数
    • attach プラグインのように独自にパスワードを取り扱うのでなければ、この関数を直接呼び出す必要がありません
    • 関連: BugTrack/709
    • PukiWiki 1.4.6 で追加されました
    • 今現在使っているのは、pkwk_login() とbasic_auth() とmd5 plugin
    • $phrase
      • (ユーザーが)入力した文字列
      • この文字列を暗号化したものが、返値の基本になります
      • $phrase は$scheme と同じフォーマット形式に暗号化されます
    • $scheme
      • 比較対象のprefix 付きパスワード、または生成したいフォーマット形式のprefix
    • $prefix
      • TRUE の時は、prefix + 暗号化された$phrase が返値となります
      • FALSE の時は、暗号化された$phrase のみが返値となります(これを比較に用いる場合は、使用する演算子に注意してください)
    • $canonical
      • FALSE の時は、$scheme にセットされたprefix をそのまま使います(返値を比較に用いる場合)
      • TRUE の時は、$scheme にセットされたprefix を整形して使用します(パスワードを新たに生成する場合)

check_editable($page, $auth_flag = TRUE, $exit_flag = TRUE)

  • 編集可能なページかを確認して、対応した処理をする
    • $auth_flag
      • TRUE だと、未認証時に入力フォームを表示、入力されたユーザ名とパスをチェックする
      • FALSE だと、現在の認証状態を使用
    • $exit_flag
      • TRUE だと、認証失敗時はedit_auth() のメッセージを、認証は成功したがis_editable() がFALSE の時はこの関数の固定メッセージを表示する
      • FALSE だと、この関数はFALSE を返すだけなので、呼び出し側で適切に処理する必要あり

check_readable($page, $auth_flag = TRUE, $exit_flag = TRUE)

  • 閲覧可能なページかを確認して、対応した処理をする
    • 現状は、read_auth() を呼び出すだけなので、オプションについては下記を参照のこと

edit_auth($page, $auth_flag = TRUE, $exit_flag = TRUE)

  • 編集認証(単機能)、check_editable() から呼び出される
    • $auth_flag
      • TRUE だと、未認証時に入力フォームを表示、入力されたユーザ名とパスをチェックする
      • FALSE だと、現在の認証状態を使用
    • $exit_flag
      • TRUE だと、認証失敗の固定メッセージを表示する
      • FALSE だと、この関数はFALSE を返すだけなので、呼び出し側で適切に処理する必要あり

read_auth($page, $auth_flag = TRUE, $exit_flag = TRUE)

  • 閲覧認証(単機能)、check_readable() から呼び出される
    • オプションはedit_auth() と同じ

basic_auth($page, $auth_flag, $exit_flag, $auth_pages, $title_cannot)

  • edit_auth()とread_auth()で共通する作業を担当
    • 基本的に、この関数を直接呼び出す必要がありません(check_editable() などを利用してください)

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2009-05-07 (木) 21:25:17
Site admin: PukiWiki Development Team

PukiWiki 1.5.2+ © 2001-2019 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u8. HTML convert time: 0.142 sec.

OSDN