xref: /freebsd/contrib/openpam/doc/man/pam_chauthtok.3 (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1.\" Generated from pam_chauthtok.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_CHAUTHTOK 3
4.Os
5.Sh NAME
6.Nm pam_chauthtok
7.Nd perform password related functions within the PAM framework
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.Ft "int"
12.Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
13.Sh DESCRIPTION
14The
15.Fn pam_chauthtok
16function attempts to change the authentication token
17for the user associated with the pam context specified by the
18.Fa pamh
19argument.
20.Pp
21The
22.Fa flags
23argument is the binary or of zero or more of the following
24values:
25.Bl -tag -width 18n
26.It Dv PAM_SILENT
27Do not emit any messages.
28.It Dv PAM_CHANGE_EXPIRED_AUTHTOK
29Change only those authentication tokens that have expired.
30.El
31.Pp
32If any other bits are set,
33.Fn pam_chauthtok
34will return
35.Dv PAM_BAD_CONSTANT .
36.Sh RETURN VALUES
37The
38.Fn pam_chauthtok
39function returns one of the following values:
40.Bl -tag -width 18n
41.It Bq Er PAM_SUCCESS
42Success.
43.It Bq Er PAM_ABORT
44General failure.
45.It Bq Er PAM_AUTHTOK_DISABLE_AGING
46Authentication token aging disabled.
47.It Bq Er PAM_AUTHTOK_ERR
48Authentication token failure.
49.It Bq Er PAM_AUTHTOK_LOCK_BUSY
50Authentication token lock busy.
51.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
52Failed to recover old authentication token.
53.It Bq Er PAM_BAD_CONSTANT
54Bad constant.
55.It Bq Er PAM_BUF_ERR
56Memory buffer error.
57.It Bq Er PAM_CONV_ERR
58Conversation failure.
59.It Bq Er PAM_PERM_DENIED
60Permission denied.
61.It Bq Er PAM_SERVICE_ERR
62Error in service module.
63.It Bq Er PAM_SYSTEM_ERR
64System error.
65.It Bq Er PAM_TRY_AGAIN
66Try again.
67.El
68.Sh SEE ALSO
69.Xr pam 3 ,
70.Xr pam_strerror 3
71.Sh STANDARDS
72.Rs
73.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
74.%D "June 1997"
75.Re
76.Sh AUTHORS
77The
78.Fn pam_chauthtok
79function and this manual page were
80developed for the
81.Fx
82Project by ThinkSec AS and Network Associates Laboratories, the
83Security Research Division of Network Associates, Inc.\& under
84DARPA/SPAWAR contract N66001-01-C-8035
85.Pq Dq CBOSS ,
86as part of the DARPA CHATS research program.
87.Pp
88The OpenPAM library is maintained by
89.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
90