| blob | a37c0d06a20d27a8955783e55315eb132f99df8a |
1 .\" $NetBSD: pam_open_session.3,v 1.4 2006/02/05 02:37:45 christos Exp $
2 .\"
3 .\"-
4 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
5 .\" Copyright (c) 2004-2007 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 .\" $P4$
38 .\"
39 .Dd December 21, 2007
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
53 The
54 .Nm
55 sets up a user session for a previously
56 authenticated user.
57 The session should later be torn down by a call to
58 .Xr pam_close_session 3 .
59 .Pp
60 The
61 .Fa flags
62 argument is the binary or of zero or more of the following
63 values:
64 .Bl -tag -width 18n
65 .It Dv PAM_SILENT
66 Do not emit any messages.
67 .El
68 .Pp
69 If any other bits are set,
70 .Nm
71 will return
72 .Dv PAM_SYMBOL_ERR .
73 .Sh RETURN VALUES
74 The
75 .Nm
76 function returns one of the following values:
77 .Bl -tag -width 18n
78 .It Bq Er PAM_ABORT
79 General failure.
80 .It Bq Er PAM_BUF_ERR
81 Memory buffer error.
82 .It Bq Er PAM_CONV_ERR
83 Conversation failure.
84 .It Bq Er PAM_PERM_DENIED
85 Permission denied.
86 .It Bq Er PAM_SERVICE_ERR
87 Error in service module.
88 .It Bq Er PAM_SESSION_ERR
89 Session failure.
90 .It Bq Er PAM_SYMBOL_ERR
91 Invalid symbol.
92 .It Bq Er PAM_SYSTEM_ERR
93 System 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
105 The
106 .Nm
107 function and this manual page were developed for the
108 .Fx
109 Project by ThinkSec AS and Network Associates Laboratories, the
110 Security Research Division of Network Associates, Inc.\& under
111 DARPA/SPAWAR contract N66001-01-C-8035
112 .Pq Dq CBOSS ,
113 as part of the DARPA CHATS research program.