source: openpam/trunk/doc/man/pam_chauthtok.3 @ 119

Last change on this file since 119 was 119, checked in by Dag-Erling Smørgrav, 19 years ago

Regenerate.

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