日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
PAM(3) FreeBSD ライブラリ関数マニュアル PAM(3)
名称
pam_acct_mgmt, pam_authenticate, pam_chauthtok, pam_close_session,
pam_end, pam_get_data, pam_get_item, pam_get_user, pam_getenv,
pam_getenvlist, pam_open_session, pam_putenv, pam_set_data, pam_set_item,
pam_setcred, pam_start, pam_strerror -- プラグ可能な認証モジュール (Plug
gable Authentication Modules) ライブラリ
ライブラリ
PAM ライブラリ (libpam, -lpam)
書式
#include <security/pam_appl.h>
int
pam_acct_mgmt(pam_handle_t *pamh, int flags);
int
pam_authenticate(pam_handle_t *pamh, int flags);
int
pam_chauthtok(pam_handle_t *pamh, int flags);
int
pam_close_session(pam_handle_t *pamh, int flags);
int
pam_end(pam_handle_t *pamh, int status);
int
pam_get_data(const pam_handle_t *pamh, const char *module_data_name,
const void **data);
int
pam_get_item(const pam_handle_t *pamh, int item_type, const void **item);
int
pam_get_user(pam_handle_t *pamh, const char **user, const char *prompt);
const char *
pam_getenv(pam_handle_t *pamh, const char *name);
char **
pam_getenvlist(pam_handle_t *pamh);
int
pam_open_session(pam_handle_t *pamh, int flags);
int
pam_putenv(pam_handle_t *pamh, const char *namevalue);
int
pam_set_data(pam_handle_t *pamh, const char *module_data_name,
void *data,
void (*cleanup)(pam_handle_t *pamh, void *data, int pam_end_status));
int
pam_set_item(pam_handle_t *pamh, int item_type, const void *item);
int
pam_setcred(pam_handle_t *pamh, int flags);
int
pam_start(const char *service, const char *user,
const struct pam_conv *pam_conv, pam_handle_t **pamh);
const char *
pam_strerror(const pam_handle_t *pamh, int error_number);
解説
プラグ可能な認証モジュール (Pluggable Authentication Modules (PAM)) ライ
ブラリは、多くの共通の認証関連の操作を要約し、いろいろば方法でこれらの操
作を実装する動的にロードされるモジュールのためのフレームワークを提供しま
す。
専門用語
PAM 専門用語では、ユーザを認証するのに PAM を使用するアプリケーションは、
サーバであり、(必ずではないが) しばしばそれは、プログラム名である、サービ
ス名によって設定目的のために識別されます。
認証を要求するユーザは、アプリカント (申込者) と呼ばれ、一方、彼の身元を
確認して、要求された証明書を彼に供与することを委託されるユーザ (通常、
ルート) は、アビトレータ (調停者) と呼ばれます。
ユーザを認証を調べて、彼が要求したどんなタスクも実行するサーバの操作の
シーケンスは、PAM トランザクションです。要求されたタスクを実行するサーバ
内のコンテキストは、セッションと呼ばれます。
PAM によって具体化される機能は、4 つの機能に分類された 6 つの基本項目に分
割されます: 認証、アカウント管理、セッション管理、およびパスワード管理で
す。
対話
PAM ライブラリは、アプリケーションがユーザと通信するために使用することが
できる会話コールバックを提供すると期待します。いくつかのモジュールは、暗
号のドングル (違法コピーを防止するための機器) かバイオメトリック (生物測
定) デバイスのような特別のハードウェアで通信するために特殊化している会話
関数を使用することができます。詳細に関しては、pam_conv(3) を参照してくだ
さい。
初期設定とクリーンアップ
pam_start() 関数は、PAM ライブラリを初期化し、その後のすべての関数呼び出
しで提供しなければならないハンドルを返します。トランザクション状態は、こ
のハンドルによって識別される構造体の中に完全に含まれているので、平行な複
数のトランザクションを行うことは可能です。
pam_end() 関数は、指定されたコンテキストに関連しているすべてのリソースを
解放し、PAM トランザクションを終わるためにいつでも呼び出すことができま
す。
記憶域
pam_set_item() と pam_get_item() 関数は、サービス名、要求と目標ユーザの名
前、会話関数、とプロンプトを含んでいる、前もって定義されたアイテムを設定
して検索します。
pam_set_data() と pam_get_data() 関数は、あるものから他を呼び出す状態を格
納するモジュールによって一般的に使用され自由形式データの名前の付けられた
チャンク (塊) を管理します。
認証
2 つの認証基本関数があります: pam_authenticate() と pam_setcred() です。
前者は、ユーザを認証しますが、後者は、ユーザの証明書を管理します。
アカウント管理
pam_acct_mgmt() 関数は、パスワードの有効期限、アカウントの有効期限、時刻
制限などのようなポリシを実行します。
セッション管理
pam_open_session() と pam_close_session() 関数は、セッションの組み立てと
分解を操作します。
パスワード管理
pam_chauthtok() 関数は、ユーザの要求、またはパスワードの期限切れのいずれ
かで、サーバにユーザのパスワードを変更できるようにします。
その他
pam_putenv(), pam_getenv() と pam_getenvlist() 関数は、セッションの間に
サーバがエクスポートしたい環境変数を設定することができるモジュールでプラ
イベートな環境リストを管理します。
pam_strerror() 関数は、指定された PAM エラーコードを説明する文字列へのポ
インタを返します。
戻り値
次の返りコードは、<security/pam_constants.h> によって定義されます:
[PAM_ABORT] 一般的な失敗。
[PAM_ACCT_EXPIRED] ユーザアカウントは、期限が切れました。
[PAM_AUTHINFO_UNAVAIL]
認証情報が利用不可能です。
[PAM_AUTHTOK_DISABLE_AGING]
認証トークンの時効が無効です。
[PAM_AUTHTOK_ERR] 認証トークン失敗。
[PAM_AUTHTOK_EXPIRED]
パスワードの期限が切れました。
[PAM_AUTHTOK_LOCK_BUSY]
認証トークンのロックがビジーです。
[PAM_AUTHTOK_RECOVERY_ERR]
古い認証トークンの復元に失敗しました。
[PAM_AUTH_ERR] 認証エラー。
[PAM_BAD_CONSTANT] 不正な定数。
[PAM_BAD_FEATURE] 認識されない機能、または制限された機能。
[PAM_BAD_HANDLE] 不正な PAM ハンドル。
[PAM_BAD_ITEM] 認識されない項目、または制限された項目。
[PAM_BUF_ERR] メモリバッファエラー。
[PAM_CONV_ERR] 会話失敗。
[PAM_CRED_ERR] ユーザ証明書の設定に失敗しました。
[PAM_CRED_EXPIRED] ユーザ証明書の期限が切れました。
[PAM_CRED_INSUFFICIENT]
証明書が不適当です。
[PAM_CRED_UNAVAIL] ユーザ証明書の検索に失敗しました。
[PAM_DOMAIN_UNKNOWN]
未知の認証ドメイン。
[PAM_IGNORE] このモジュールを無視。
[PAM_MAXTRIES] 試行の最大数を超過しました。
[PAM_MODULE_UNKNOWN]
未知のモジュールタイプ。
[PAM_NEW_AUTHTOK_REQD]
新しい認証トークンが必要です。
[PAM_NO_MODULE_DATA]
モジュールデータが見つかりません。
[PAM_OPEN_ERR] モジュールのロードに失敗しました。
[PAM_PERM_DENIED] パーミッション (許可) が拒否されました。
[PAM_SERVICE_ERR] サービスモジュールでのエラー。
[PAM_SESSION_ERR] セッション失敗。
[PAM_SUCCESS] 成功。
[PAM_SYMBOL_ERR] 無効のシンボル。
[PAM_SYSTEM_ERR] システムエラー。
[PAM_TRY_AGAIN] 再試行してください。
[PAM_USER_UNKNOWN] 未知のユーザ。
関連項目
openpam(3), pam_acct_mgmt(3), pam_authenticate(3), pam_chauthtok(3),
pam_close_session(3), pam_conv(3), pam_end(3), pam_get_data(3),
pam_getenv(3), pam_getenvlist(3), pam_get_item(3), pam_get_user(3),
pam_open_session(3), pam_putenv(3), pam_setcred(3), pam_set_data(3),
pam_set_item(3), pam_start(3), pam_strerror(3)
規格
X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules,
June 1997.
作者
OpenPAM ライブラリとこのマニュアルページは、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> によって保守されて
います。
FreeBSD 12.1 April 30, 2017 FreeBSD 12.1