1.\" Generated from pam_chauthtok.c by gendoc.pl
2.\" $Id: pam_chauthtok.c 648 2013-03-05 17:54:27Z des $
3.Dd September 7, 2013
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 LIBRARY
10.Lb libpam
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_SYMBOL_ERR .
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_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_BUF_ERR
55Memory buffer error.
56.It Bq Er PAM_CONV_ERR
57Conversation failure.
58.It Bq Er PAM_PERM_DENIED
59Permission denied.
60.It Bq Er PAM_SERVICE_ERR
61Error in service module.
62.It Bq Er PAM_SYMBOL_ERR
63Invalid symbol.
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 des@des.no .
2.\" $Id: pam_chauthtok.c 648 2013-03-05 17:54:27Z des $
3.Dd September 7, 2013
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 LIBRARY
10.Lb libpam
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_SYMBOL_ERR .
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_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_BUF_ERR
55Memory buffer error.
56.It Bq Er PAM_CONV_ERR
57Conversation failure.
58.It Bq Er PAM_PERM_DENIED
59Permission denied.
60.It Bq Er PAM_SERVICE_ERR
61Error in service module.
62.It Bq Er PAM_SYMBOL_ERR
63Invalid symbol.
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 des@des.no .