1.\" Generated from pam_open_session.c by gendoc.pl
2.\" $Id: pam_open_session.c 648 2013-03-05 17:54:27Z des $
3.Dd September 12, 2014
4.Dt PAM_OPEN_SESSION 3
5.Os
6.Sh NAME
7.Nm pam_open_session
8.Nd open a user session
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "int"
15.Fn pam_open_session "pam_handle_t *pamh" "int flags"
16.Sh DESCRIPTION
17The
18.Fn pam_open_session
19sets up a user session for a previously
20authenticated user.
21The session should later be torn down by a call to
22.Xr pam_close_session 3 .
23.Pp
24The
25.Fa flags
26argument is the binary or of zero or more of the following
27values:
28.Bl -tag -width 18n
29.It Dv PAM_SILENT
30Do not emit any messages.
31.El
32.Pp
33If any other bits are set,
34.Fn pam_open_session
35will return
36.Dv PAM_SYMBOL_ERR .
37.Sh RETURN VALUES
38The
39.Fn pam_open_session
40function returns one of the following values:
41.Bl -tag -width 18n
42.It Bq Er PAM_ABORT
43General failure.
44.It Bq Er PAM_BUF_ERR
45Memory buffer error.
46.It Bq Er PAM_CONV_ERR
47Conversation failure.
48.It Bq Er PAM_PERM_DENIED
49Permission denied.
50.It Bq Er PAM_SERVICE_ERR
51Error in service module.
52.It Bq Er PAM_SESSION_ERR
53Session failure.
54.It Bq Er PAM_SYMBOL_ERR
55Invalid symbol.
56.It Bq Er PAM_SYSTEM_ERR
57System error.
58.El
59.Sh SEE ALSO
60.Xr pam 3 ,
61.Xr pam_close_session 3 ,
62.Xr pam_strerror 3
63.Sh STANDARDS
64.Rs
65.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
66.%D "June 1997"
67.Re
68.Sh AUTHORS
69The
70.Fn pam_open_session
71function and this manual page were
72developed for the
73.Fx
74Project by ThinkSec AS and Network Associates Laboratories, the
75Security Research Division of Network Associates, Inc.\& under
76DARPA/SPAWAR contract N66001-01-C-8035
77.Pq Dq CBOSS ,
78as part of the DARPA CHATS research program.
79.Pp
80The OpenPAM library is maintained by
81.An Dag-Erling Sm\(/orgrav Aq des@des.no .
82