pam_sm_authenticate(3)

構文

cc [ flag ... ] file ... -lpam [ library ... ]

#include <security/pam_appl.h>

#include <security/pam_modules.h>

int pam_sm_authenticate(pam_handle_t *pamh, int flags, int argc,
const char **argv);

説明

pam_authenticate(3) の呼び出しに応じて、PAM フレームワークが pam.conf(4) ファイルにリストされたモジュールから pam_sm_authenticate() を呼び出します。認証プロバイダは、このインタフェース関数のバックエンド機能を提供します。

関数 pam_sm_authenticate() が呼び出されると、現ユーザーの身元を検査します。通常、システム内で構成されている認証方式に基づき、ユーザーにパスワードまたは認証トークンの入力を要求します。対象ユーザーは以前に呼び出した pam_start() で指定され、認証ハンドル pamh で参照されます。

ユーザーが認証サービスに認識されない場合、サービスモジュールはこのエラーをマスクし、続けてユーザーにパスワード入力を求めるプロンプトを表示します。その後で、エラー PAM_USER_UNKNOWN を返します。

pam_sm_authenticate() には以下のフラグを渡せます。

argc 引き数は、構成ファイル pam.conf(4) から渡されるモジュールオプションの数を示します。 argv は、モジュールオプションを指定します。モジュールオプションは認証サービスにより解釈され、処理されます。使用できる各 options については、特定モジュールのマンページを参照してください。未知のオプションが渡された場合、モジュールはエラーを記録し、そのオプションを無視します。

pam_sm_authenticate() は、処理を終える前に pam_get_item() を呼び出して PAM_AUTHTOK を取り出します。この値が設定されていない場合 (すなわち、値が NULL の場合)、 pam_sm_authenticate() は、 pam_set_item() を使ってユーザーが入力したパスワードを設定します。

認証モジュールは、 pam_set_data() を使って、認証ステータス (成功値、または失敗の原因を示す値) を認証ハンドルに設定することがあります。この値は、 pam_setcred() が使用します。

アプリケーション使用法

PAM インタフェースのスレッドへの対応状況については、 pam(3) を参照してください。

注意

モジュールはイベントが失敗した場合でも認証を再試行しません。アプリケーションが認証を再試行し、リトライ回数を管理します。リトライ回数を制限するには、モジュールから PAM_MAXTRIES エラーを返します。

戻り値

正常終了すると、 PAM_SUCCESS が返されます。また、以下の値が返されることがあります。

参照

pam(3), pam_authenticate(3), pam.conf(4), pam_user.conf(4)