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