1.\" $NetBSD: pam_sm_chauthtok.3,v 1.3 2013/04/06 02:20:29 christos Exp $ 2.\" 3.\"- 4.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 5.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 6.\" All rights reserved. 7.\" 8.\" This software was developed for the FreeBSD Project by ThinkSec AS and 9.\" Network Associates Laboratories, the Security Research Division of 10.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 11.\" ("CBOSS"), as part of the DARPA CHATS research program. 12.\" 13.\" Redistribution and use in source and binary forms, with or without 14.\" modification, are permitted provided that the following conditions 15.\" are met: 16.\" 1. Redistributions of source code must retain the above copyright 17.\" notice, this list of conditions and the following disclaimer. 18.\" 2. Redistributions in binary form must reproduce the above copyright 19.\" notice, this list of conditions and the following disclaimer in the 20.\" documentation and/or other materials provided with the distribution. 21.\" 3. The name of the author may not be used to endorse or promote 22.\" products derived from this software without specific prior written 23.\" permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 35.\" SUCH DAMAGE. 36.\" 37.\" Id 38.\" 39.Dd May 26, 2012 40.Dt PAM_SM_CHAUTHTOK 3 41.Os 42.Sh NAME 43.Nm pam_sm_chauthtok 44.Nd service module implementation for pam_chauthtok 45.Sh LIBRARY 46.Lb libpam 47.Sh SYNOPSIS 48.In sys/types.h 49.In security/pam_appl.h 50.In security/pam_modules.h 51.Ft "int" 52.Fn pam_sm_chauthtok "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" 53.Sh DESCRIPTION 54The 55.Fn pam_sm_chauthtok 56function is the service module's implementation 57of the 58.Xr pam_chauthtok 3 59API function. 60.Pp 61When the application calls 62.Xr pam_chauthtok 3 , 63the service function is 64called twice, first with the 65.Dv PAM_PRELIM_CHECK 66flag set and then again 67with the 68.Dv PAM_UPDATE_AUTHTOK 69flag set. 70.Sh RETURN VALUES 71The 72.Fn pam_sm_chauthtok 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_IGNORE 90Ignore this module. 91.It Bq Er PAM_PERM_DENIED 92Permission denied. 93.It Bq Er PAM_SERVICE_ERR 94Error in service module. 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_chauthtok 3 , 103.Xr pam_strerror 3 104.Sh STANDARDS 105.Rs 106.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 107.%D "June 1997" 108.Re 109.Sh AUTHORS 110The 111.Fn pam_sm_chauthtok 112function and this manual page were 113developed for the 114.Fx 115Project by ThinkSec AS and Network Associates Laboratories, the 116Security Research Division of Network Associates, Inc.\& under 117DARPA/SPAWAR contract N66001-01-C-8035 118.Pq Dq CBOSS , 119as part of the DARPA CHATS research program. 120