xref: /freebsd/contrib/openpam/doc/man/pam_sm_chauthtok.3 (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1.\" Generated from pam_sm_chauthtok.c by gendoc.pl
2.\" $OpenPAM: pam_sm_chauthtok.c 938 2017-04-30 21:34:42Z des $
3.Dd February 24, 2019
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_SUCCESS
38Success.
39.It Bq Er PAM_ABORT
40General failure.
41.It Bq Er PAM_AUTHTOK_DISABLE_AGING
42Authentication token aging disabled.
43.It Bq Er PAM_AUTHTOK_ERR
44Authentication token failure.
45.It Bq Er PAM_AUTHTOK_LOCK_BUSY
46Authentication token lock busy.
47.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
48Failed to recover old authentication token.
49.It Bq Er PAM_BUF_ERR
50Memory buffer error.
51.It Bq Er PAM_CONV_ERR
52Conversation failure.
53.It Bq Er PAM_IGNORE
54Ignore this module.
55.It Bq Er PAM_PERM_DENIED
56Permission denied.
57.It Bq Er PAM_SERVICE_ERR
58Error in service module.
59.It Bq Er PAM_SYSTEM_ERR
60System error.
61.It Bq Er PAM_TRY_AGAIN
62Try again.
63.El
64.Sh SEE ALSO
65.Xr pam 3 ,
66.Xr pam_chauthtok 3 ,
67.Xr pam_strerror 3
68.Sh STANDARDS
69.Rs
70.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
71.%D "June 1997"
72.Re
73.Sh AUTHORS
74The
75.Fn pam_sm_chauthtok
76function and this manual page were
77developed for the
78.Fx
79Project by ThinkSec AS and Network Associates Laboratories, the
80Security Research Division of Network Associates, Inc.\& under
81DARPA/SPAWAR contract N66001-01-C-8035
82.Pq Dq CBOSS ,
83as part of the DARPA CHATS research program.
84.Pp
85The OpenPAM library is maintained by
86.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
87