1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" All rights reserved. 4.\" 5.\" This software was developed for the FreeBSD Project by ThinkSec AS and 6.\" Network Associates Laboratories, the Security Research Division of 7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 8.\" ("CBOSS"), as part of the 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$ 35.\" 36.Dd June 16, 2005 37.Dt PAM_START 3 38.Os 39.Sh NAME 40.Nm pam_start 41.Nd initiate a PAM transaction 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In sys/types.h 46.In security/pam_appl.h 47.Ft "int" 48.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" 49.Sh DESCRIPTION 50The 51.Nm 52function creates and initializes a PAM context. 53.Pp 54The 55.Fa service 56argument specifies the name of the policy to apply, and is 57stored in the 58.Dv PAM_SERVICE 59item in the created context. 60.Pp 61The 62.Fa user 63argument specifies the name of the target user - the user the 64created context will serve to authenticate. 65It is stored in the 66.Dv PAM_USER 67item in the created context. 68.Pp 69The 70.Fa pam_conv 71argument points to a 72.Vt struct pam_conv 73describing the 74conversation function to use; see 75.Fa pam_conv 76for details. 77.Pp 78.Sh RETURN VALUES 79The 80.Nm 81function returns one of the following values: 82.Bl -tag -width 18n 83.It Bq Er PAM_BUF_ERR 84Memory buffer error. 85.It Bq Er PAM_SYSTEM_ERR 86System error. 87.El 88.Sh SEE ALSO 89.Xr pam 3 , 90.Xr pam_end 3 , 91.Xr pam_get_item 3 , 92.Xr pam_set_item 3 , 93.Xr pam_strerror 3 94.Sh STANDARDS 95.Rs 96.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 97.%D "June 1997" 98.Re 99.Sh AUTHORS 100The 101.Nm 102function and this manual page were developed for the 103.Fx 104Project by ThinkSec AS and Network Associates Laboratories, the 105Security Research Division of Network Associates, Inc.& under 106DARPA/SPAWAR contract N66001-01-C-8035 107.Pq Dq CBOSS , 108as part of the DARPA CHATS research program. 109