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