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