xref: /freebsd/contrib/openpam/doc/man/pam_sm_chauthtok.3 (revision 5944f899a2519c6321bac3c17cc076418643a088)
1.\" Generated from pam_sm_chauthtok.c by gendoc.pl
2.\" $Id: pam_sm_chauthtok.c 648 2013-03-05 17:54:27Z des $
3.Dd February 19, 2017
4.Dt PAM_SM_CHAUTHTOK 3
5.Os
6.Sh NAME
7.Nm pam_sm_chauthtok
8.Nd service module implementation for pam_chauthtok
9.Sh SYNOPSIS
10.In sys/types.h
11.In security/pam_appl.h
12.In security/pam_modules.h
13.Ft "int"
14.Fn pam_sm_chauthtok "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
15.Sh DESCRIPTION
16The
17.Fn pam_sm_chauthtok
18function is the service module's implementation
19of the
20.Xr pam_chauthtok 3
21API function.
22.Pp
23When the application calls
24.Xr pam_chauthtok 3 ,
25the service function is
26called twice, first with the
27.Dv PAM_PRELIM_CHECK
28flag set and then again
29with the
30.Dv PAM_UPDATE_AUTHTOK
31flag set.
32.Sh RETURN VALUES
33The
34.Fn pam_sm_chauthtok
35function returns one of the following values:
36.Bl -tag -width 18n
37.It Bq Er PAM_ABORT
38General failure.
39.It Bq Er PAM_AUTHTOK_DISABLE_AGING
40Authentication token aging disabled.
41.It Bq Er PAM_AUTHTOK_ERR
42Authentication token failure.
43.It Bq Er PAM_AUTHTOK_LOCK_BUSY
44Authentication token lock busy.
45.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
46Failed to recover old authentication token.
47.It Bq Er PAM_BUF_ERR
48Memory buffer error.
49.It Bq Er PAM_CONV_ERR
50Conversation failure.
51.It Bq Er PAM_IGNORE
52Ignore this module.
53.It Bq Er PAM_PERM_DENIED
54Permission denied.
55.It Bq Er PAM_SERVICE_ERR
56Error in service module.
57.It Bq Er PAM_SYSTEM_ERR
58System error.
59.It Bq Er PAM_TRY_AGAIN
60Try again.
61.El
62.Sh SEE ALSO
63.Xr pam 3 ,
64.Xr pam_chauthtok 3 ,
65.Xr pam_strerror 3
66.Sh STANDARDS
67.Rs
68.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
69.%D "June 1997"
70.Re
71.Sh AUTHORS
72The
73.Fn pam_sm_chauthtok
74function and this manual page were
75developed for the
76.Fx
77Project by ThinkSec AS and Network Associates Laboratories, the
78Security Research Division of Network Associates, Inc.\& under
79DARPA/SPAWAR contract N66001-01-C-8035
80.Pq Dq CBOSS ,
81as part of the DARPA CHATS research program.
82.Pp
83The OpenPAM library is maintained by
84.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
85