xref: /freebsd/contrib/openpam/doc/man/pam_sm_open_session.3 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $P4$
36.\"
37.Dd December 21, 2007
38.Dt PAM_SM_OPEN_SESSION 3
39.Os
40.Sh NAME
41.Nm pam_sm_open_session
42.Nd service module implementation for pam_open_session
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.In security/pam_modules.h
49.Ft "int"
50.Fn pam_sm_open_session "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
51.Sh DESCRIPTION
52The
53.Nm
54function is the service module's
55implementation of the
56.Xr pam_open_session 3
57API function.
58.Sh RETURN VALUES
59The
60.Nm
61function returns one of the following values:
62.Bl -tag -width 18n
63.It Bq Er PAM_ABORT
64General failure.
65.It Bq Er PAM_BUF_ERR
66Memory buffer error.
67.It Bq Er PAM_CONV_ERR
68Conversation failure.
69.It Bq Er PAM_IGNORE
70Ignore this module.
71.It Bq Er PAM_PERM_DENIED
72Permission denied.
73.It Bq Er PAM_SERVICE_ERR
74Error in service module.
75.It Bq Er PAM_SESSION_ERR
76Session failure.
77.It Bq Er PAM_SYSTEM_ERR
78System error.
79.El
80.Sh SEE ALSO
81.Xr pam 3 ,
82.Xr pam_open_session 3 ,
83.Xr pam_strerror 3
84.Sh STANDARDS
85.Rs
86.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
87.%D "June 1997"
88.Re
89.Sh AUTHORS
90The
91.Nm
92function and this manual page were developed for the
93.Fx
94Project by ThinkSec AS and Network Associates Laboratories, the
95Security Research Division of Network Associates, Inc.\& under
96DARPA/SPAWAR contract N66001-01-C-8035
97.Pq Dq CBOSS ,
98as part of the DARPA CHATS research program.
99