.\" Hey Emacs! This file is -*- nroff -*- source.
.\" $Id: pam_chauthtok.3,v 1.5 2002-11-03 06:38:28 horikawa Exp $
.\" %FreeBSD: src/contrib/libpam/doc/man/Attic/pam_chauthtok.3,v 1.2.6.2 2001/06/11 15:28:11 markm Exp %
.\" Copyright (c) Andrew G. Morgan 1997 <morgan@parc.power.net>
.\" $FreeBSD$
.TH PAM_CHAUTHTOK 3 "1997 Jan 4" "PAM 0.55" "App. Programmers' Manual"
.SH 名称

pam_chauthtok \- 認証トークンの更新

.SH 書式
.B #include <security/pam_appl.h>
.sp
.BI "int pam_chauthtok(pam_handle_t " *pamh ", int  " flags ");"
.sp 2
.SH 解説
.B pam_chauthtok

.br
この関数を使用すると、申請ユーザの認証トークン (パスワードなど) を
更新できます。

.br
アプリケーションでユーザをあらかじめ認証すべきではありません。
認証は
.BR PAM
フレームワークで必要に応じて実行されます。

.br
.I flags
引数が、値
.BR PAM_CHANGE_EXPIRED_AUTHTOK
を取ることが
.I あります。
この場合、期限が切れた認証トークンのみを、
フレームワークが更新する必要があります。
この引数がないと、フレームワークはすべての設定済み認証
メカニズムに対し、新しいトークンを取得しようとします。
型の詳細やスキーム数は、呼び出しアプリケーションに無関係であるべきです。

.SH 戻り値
この関数から問題なく戻ると、
.BR PAM_SUCCESS
が戻されます。

.br
この関数を呼び出した場合にとくに注意すべきエラーは以下のとおりです。

.br
.BR PAM_AUTHTOK_ERROR
- 有効な新しいトークンを取得できませんでした。

.br
.BR PAM_AUTHTOK_RECOVERY_ERR
- 古い認証トークンを使用できませんでした。

.br
.BR PAM_AUTHTOK_LOCK_BUSY
- トークンの更新に必要なリソースがロックされていました。
後で再度実行してください。

.br
.BR PAM_AUTHTOK_DISABLE_AGING
- 1 つ以上の認証モジュールが、認証トークンのエージングを認めませんでした。

.br
.BR PAM_TRY_AGAIN
- 1 つ以上の認証メカニズムで、トークンの更新のための準備が今できていません。

.br
一般的にはその他の戻り値も戻されます。エラーを示しているものとして
扱ってください。

.SH エラー
.BR pam_strerror "(3)"
でテキストに変換できます。

.SH 準拠
DCE-RFC 86.0, October 1995.

.SH バグ
.sp 2
見つかっていません。

.SH 関連項目
.BR pam_start "(3), "
.BR pam_authenticate "(3), "
.BR pam_setcred "(3), "
.BR pam_get_item "(3), "
.BR pam_strerror "(3) "
.BR pam "(8)."

.br
.BR システム管理者
、
.BR モジュール開発者
、
.BR アプリケーション開発者
用の
.BR PAM
ガイドも参照してください。