1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2011 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.\" $Id$
36.\"
37.Dd May 26, 2012
38.Dt PAM_SM_CHAUTHTOK 3
39.Os
40.Sh NAME
41.Nm pam_sm_chauthtok
42.Nd service module implementation for pam_chauthtok
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.In security/pam_modules.h
49.Ft "int"
50.Fn pam_sm_chauthtok "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
51.Sh DESCRIPTION
52The
53.Fn pam_sm_chauthtok
54function is the service module's implementation
55of the
56.Xr pam_chauthtok 3
57API function.
58.Pp
59When the application calls
60.Xr pam_chauthtok 3 ,
61the service function is
62called twice, first with the
63.Dv PAM_PRELIM_CHECK
64flag set and then again
65with the
66.Dv PAM_UPDATE_AUTHTOK
67flag set.
68.Sh RETURN VALUES
69The
70.Fn pam_sm_chauthtok
71function returns one of the following values:
72.Bl -tag -width 18n
73.It Bq Er PAM_ABORT
74General failure.
75.It Bq Er PAM_AUTHTOK_DISABLE_AGING
76Authentication token aging disabled.
77.It Bq Er PAM_AUTHTOK_ERR
78Authentication token failure.
79.It Bq Er PAM_AUTHTOK_LOCK_BUSY
80Authentication token lock busy.
81.It Bq Er PAM_AUTHTOK_RECOVERY_ERR
82Failed to recover old authentication token.
83.It Bq Er PAM_BUF_ERR
84Memory buffer error.
85.It Bq Er PAM_CONV_ERR
86Conversation failure.
87.It Bq Er PAM_IGNORE
88Ignore this module.
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_SYSTEM_ERR
94System error.
95.It Bq Er PAM_TRY_AGAIN
96Try again.
97.El
98.Sh SEE ALSO
99.Xr pam 3 ,
100.Xr pam_chauthtok 3 ,
101.Xr pam_strerror 3
102.Sh STANDARDS
103.Rs
104.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
105.%D "June 1997"
106.Re
107.Sh AUTHORS
108The
109.Fn pam_sm_chauthtok
110function and this manual page were
111developed for the
112.Fx
113Project by ThinkSec AS and Network Associates Laboratories, the
114Security Research Division of Network Associates, Inc.\& under
115DARPA/SPAWAR contract N66001-01-C-8035
116.Pq Dq CBOSS ,
117as part of the DARPA CHATS research program.
118