xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_open_session.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: pam_open_session.3,v 1.8 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from pam_open_session.c by gendoc.pl
4.\" $OpenPAM: pam_open_session.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
6.Dt PAM_OPEN_SESSION 3
7.Os
8.Sh NAME
9.Nm pam_open_session
10.Nd open a user session
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_BAD_CONSTANT .
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_SUCCESS
43Success.
44.It Bq Er PAM_ABORT
45General failure.
46.It Bq Er PAM_BAD_CONSTANT
47Bad constant.
48.It Bq Er PAM_BUF_ERR
49Memory buffer error.
50.It Bq Er PAM_CONV_ERR
51Conversation failure.
52.It Bq Er PAM_PERM_DENIED
53Permission denied.
54.It Bq Er PAM_SERVICE_ERR
55Error in service module.
56.It Bq Er PAM_SESSION_ERR
57Session failure.
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 Mt des@des.no .
84