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