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.\" 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 30, 2002 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 security/pam_appl.h 46.Ft int 47.Fn pam_start "const char *service" "const char *user" "const struct pam_conv *pam_conv" "pam_handle_t **pamh" 48.Sh DESCRIPTION 49The 50.Nm 51function creates and initializes a PAM context. 52.Pp 53The 54.Va service 55argument specifies the name of the policy to apply, and is 56stored in the 57.Dv PAM_SERVICE 58item in the created context. 59.Pp 60The 61.Va user 62argument specifies the name of the target user - the user the 63created context will serve to authenticate. 64It is stored in the 65.Dv PAM_USER 66item in the created context. 67.Pp 68The 69.Va pam_conv 70argument points to a 71.Vt struct pam_conv 72describing the 73conversation function to use; see 74.Va pam_conv 75for details. 76.Pp 77.Sh RETURN VALUES 78The 79.Nm 80function returns one of the following values: 81.Bl -tag -width 18n 82.It Bq Er PAM_BUF_ERR 83Memory buffer error. 84.It Bq Er PAM_SYSTEM_ERR 85System error. 86.El 87.Sh SEE ALSO 88.Xr pam 3 , 89.Xr pam_end 3 , 90.Xr pam_get_item 3 , 91.Xr pam_set_item 3 , 92.Xr pam_strerror 3 93.Sh STANDARDS 94.Rs 95.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 96.%D "June 1997" 97.Re 98.Sh AUTHORS 99The 100.Nm 101function and this manual page were developed for the FreeBSD Project 102by ThinkSec AS and Network Associates Laboratories, the Security 103Research Division of Network Associates, Inc. under DARPA/SPAWAR 104contract N66001-01-C-8035 105.Pq Dq CBOSS , 106as part of the DARPA CHATS research program. 107