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