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_OPEN_SESSION 3 38.Os 39.Sh NAME 40.Nm pam_open_session 41.Nd open a user session 42.Sh LIBRARY 43.Lb libpam 44.Sh SYNOPSIS 45.In security/pam_appl.h 46.Ft int 47.Fn pam_open_session "pam_handle_t *pamh" "int flags" 48.Sh DESCRIPTION 49The 50.Nm 51sets up a user session for a previously 52authenticated user. The session should later be torn down by a call to 53.Xr pam_close_session 3 . 54.Pp 55The 56.Va flags 57argument is the binary or of zero or more of the following 58values: 59.Bl -tag -width 18n 60.It Dv PAM_SILENT 61Do not emit any messages. 62.El 63.Pp 64If any other bits are set, 65.Nm 66will return 67.Dv PAM_SYMBOL_ERR . 68.Sh RETURN VALUES 69The 70.Nm 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_BUF_ERR 76Memory buffer error. 77.It Bq Er PAM_CONV_ERR 78Conversation failure. 79.It Bq Er PAM_PERM_DENIED 80Permission denied. 81.It Bq Er PAM_SERVICE_ERR 82Error in service module. 83.It Bq Er PAM_SESSION_ERR 84Session failure. 85.It Bq Er PAM_SYMBOL_ERR 86Invalid symbol. 87.It Bq Er PAM_SYSTEM_ERR 88System error. 89.El 90.Sh SEE ALSO 91.Xr pam 3 , 92.Xr pam_close_session 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 FreeBSD Project 103by ThinkSec AS and Network Associates Laboratories, the Security 104Research Division of Network Associates, Inc. under DARPA/SPAWAR 105contract N66001-01-C-8035 106.Pq Dq CBOSS , 107as part of the DARPA CHATS research program. 108