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