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