1.\" $NetBSD: pam_open_session.3,v 1.3 2013/04/06 02:20:28 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_OPEN_SESSION 3 41.Os 42.Sh NAME 43.Nm pam_open_session 44.Nd open a user session 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_open_session "pam_handle_t *pamh" "int flags" 52.Sh DESCRIPTION 53The 54.Fn pam_open_session 55sets up a user session for a previously 56authenticated user. 57The session should later be torn down by a call to 58.Xr pam_close_session 3 . 59.Pp 60The 61.Fa flags 62argument is the binary or of zero or more of the following 63values: 64.Bl -tag -width 18n 65.It Dv PAM_SILENT 66Do not emit any messages. 67.El 68.Pp 69If any other bits are set, 70.Fn pam_open_session 71will return 72.Dv PAM_SYMBOL_ERR . 73.Sh RETURN VALUES 74The 75.Fn pam_open_session 76function returns one of the following values: 77.Bl -tag -width 18n 78.It Bq Er PAM_ABORT 79General failure. 80.It Bq Er PAM_BUF_ERR 81Memory buffer error. 82.It Bq Er PAM_CONV_ERR 83Conversation failure. 84.It Bq Er PAM_PERM_DENIED 85Permission denied. 86.It Bq Er PAM_SERVICE_ERR 87Error in service module. 88.It Bq Er PAM_SESSION_ERR 89Session failure. 90.It Bq Er PAM_SYMBOL_ERR 91Invalid symbol. 92.It Bq Er PAM_SYSTEM_ERR 93System error. 94.El 95.Sh SEE ALSO 96.Xr pam 3 , 97.Xr pam_close_session 3 , 98.Xr pam_strerror 3 99.Sh STANDARDS 100.Rs 101.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 102.%D "June 1997" 103.Re 104.Sh AUTHORS 105The 106.Fn pam_open_session 107function and this manual page were 108developed for the 109.Fx 110Project by ThinkSec AS and Network Associates Laboratories, the 111Security Research Division of Network Associates, Inc.\& under 112DARPA/SPAWAR contract N66001-01-C-8035 113.Pq Dq CBOSS , 114as part of the DARPA CHATS research program. 115