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