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