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