xref: /freebsd/contrib/openpam/doc/man/pam_chauthtok.3 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $P4$
36.\"
37.Dd December 21, 2007
38.Dt PAM_CHAUTHTOK 3
39.Os
40.Sh NAME
41.Nm pam_chauthtok
42.Nd perform password related functions within the PAM framework
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.Ft "int"
49.Fn pam_chauthtok "pam_handle_t *pamh" "int flags"
50.Sh DESCRIPTION
51The
52.Nm
53function attempts to change the authentication token
54for the user associated with the pam context specified by the
55.Fa pamh
56argument.
57.Pp
58The
59.Fa flags
60argument is the binary or of zero or more of the following
61values:
62.Bl -tag -width 18n
63.It Dv PAM_SILENT
64Do not emit any messages.
65.It Dv PAM_CHANGE_EXPIRED_AUTHTOK
66Change only those authentication tokens that have expired.
67.El
68.Pp
69If any other bits are set,
70.Nm
71will return
72.Dv PAM_SYMBOL_ERR .
73.Sh RETURN VALUES
74The
75.Nm
76function returns one of the following values:
77.Bl -tag -width 18n
78.It Bq Er PAM_ABORT
79General failure.
80.It Bq Er PAM_AUTHTOK_DISABLE_AGING
81Authentication token aging disabled.
82.It Bq Er PAM_AUTHTOK_ERR
83Authentication token failure.
84.It Bq Er PAM_AUTHTOK_LOCK_BUSY
85Authentication token lock busy.
86.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
87Failed to recover old authentication token.
88.It Bq Er PAM_BUF_ERR
89Memory buffer error.
90.It Bq Er PAM_CONV_ERR
91Conversation failure.
92.It Bq Er PAM_PERM_DENIED
93Permission denied.
94.It Bq Er PAM_SERVICE_ERR
95Error in service module.
96.It Bq Er PAM_SYMBOL_ERR
97Invalid symbol.
98.It Bq Er PAM_SYSTEM_ERR
99System error.
100.It Bq Er PAM_TRY_AGAIN
101Try again.
102.El
103.Sh SEE ALSO
104.Xr pam 3 ,
105.Xr pam_strerror 3
106.Sh STANDARDS
107.Rs
108.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
109.%D "June 1997"
110.Re
111.Sh AUTHORS
112The
113.Nm
114function and this manual page were developed for the
115.Fx
116Project by ThinkSec AS and Network Associates Laboratories, the
117Security Research Division of Network Associates, Inc.\& under
118DARPA/SPAWAR contract N66001-01-C-8035
119.Pq Dq CBOSS ,
120as part of the DARPA CHATS research program.
121