名称

pam_get_user — ユーザ名を検索する

ライブラリ

Pluggable Authentication Module Library (libpam, -lpam)

書式

#include < sys/types.h>
#include < security/pam_appl.h>

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

解説

pam_get_user() 関数は、 pam_start(3) に指定されるように目的の (ターゲット) ユーザの名前を返します。ユーザが指定されていないか、 pam_set_item(3) を使って設定されていなければ、 pam_get_user() ユーザ名の入力を促します。どちらにしても、ユーザ名へのポインタは、 user 引数によって指された位置に格納され、対応する PAM 項目は、更新されます。

prompt 引数は、ユーザ名が貯蔵 (キャッシュ) されていないなら、使用するプロンプトを指定します。それが NULL であるなら、 PAM_USER_PROMPT 項目が使用されます。また、その項目が NULL であるなら、決め打ちされたデフォルトのプロンプトが使用されます。さらに、 pam_get_user() がサービスモジュールから呼び出されるとき、プロンプトは、下記に記述されるようなモジュールオプションによって影響されます。次に、プロンプトは、それが会話関数に渡される前に、 openpam_subst(3) を使用して拡張されます。

モジュールオプション

サービスモジュールによって呼び出されるとき、 pam_get_user() は、次のモジュールオプションを認識します:

user_prompt

ユーザ名を問い合わせるとき、使用するプロンプト。このオプションは、 prompt 引数と PAM_USER_PROMPT 項目の両方を上書きします。

戻り値

pam_get_user() 関数は、次の値の 1 つを返します:

[ PAM_BUF_ERR]

メモリバッファエラー。

[ PAM_CONV_ERR]

会話失敗。

[ PAM_SYSTEM_ERR]

システムエラー。

関連項目

openpam_get_option(3), openpam_subst(3), pam(3), pam_conv(3), pam_get_authtok(3), pam_get_item(3), pam_set_item(3), pam_start(3), pam_strerror(3)

規格

X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules, June 1997.

作者

pam_get_user() 関数とこのマニュアルページは、 FreeBSD プロジェクトのために DARPA CHATS 研究プログラムの一環として DARPA/SPAWAR 規約 N66001-01-C-8035 (“CBOSS”) の下で ThinkSec AS と Network Associates Laboratories, the Security Research Division of Network Associates, Inc. によって開発されました。

OpenPAM ライブラリは、 Dag-Erling Smørgrav <des@des.no>によって保守されています。