pam_get_user(3)

構文

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

#include <security/pam_appl.h>

int pam_get_user(pam_handle_t *pamh, char **user, const char *prompt);

説明

pam_get_user() は、PAM サービスモジュールが PAM ハンドルから現在のユーザー名を取り出すために使用します。ユーザー名が pam_start() または pam_set_item() によって設定されていない場合、PAM 会話関数を使用して、文字列 "prompt" を使ってユーザーにユーザー名の入力を求めるプロンプトを表示します。 prompt が NULL の場合、 pam_get_item() を呼び出し、プロンプト表示には PAM_USER_PROMPT の値を使用します。 PAM_USER_PROMPT の値が NULL の場合、次のデフォルトのプロンプトを使用します。

会話関数によりユーザー名を得たら、 pam_set_item() を呼び出して PAM_USER の値を設定します。

規約によれば、ユーザー名の入力を求めるプロンプトを表示する必要があるアプリケーションは、 pam_authenticate() を呼び出す前に、 pam_set_item() を呼び出して PAM_USER_PROMPT の値を設定しなければなりません。その後、このサービスモジュールの pam_sm_authenticate() 関数は pam_get_user() を呼び出し、ユーザー名の入力を求めるプロンプトを表示します。ある一定の PAM サービスモジュール (スマートカード モジュールなど) は、 PAM_USER_PROMPT の値を変更して固有のプロンプトを渡す場合があることに注意してください。

pam_authenticate() を複数回呼び出すアプリケーションは、ユーザーに毎回新しいユーザー名の入力を求めるプロンプトを表示したい場合、 pam_authenticate() を呼び出す前に pam_set_item() で PAM_USER の値を NULL に設定しなければなりません。

pam_get_user() で取り出した user の値は、変更したり解放してはなりません。この項目は pam_end() により解放されます。

アプリケーション使用法

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

戻り値

正常終了すると、 pam_get_user() は PAM_SUCCESS を返します。失敗すると、エラーコードを返します。戻り値に関連したエラーの情報については、 pam(3) を参照してください。

参照

pam(3), pam_start(3), pam_authenticate(3), pam_get_item(3), pam_set_item(3), pam_sm(3), pam_sm_authenticate(3), pam_end(3)