summaryrefslogtreecommitdiff
path: root/doc/man/pam_open_session.3
blob: 7105a056a46dbefd8fd06ce61a1d92a637ad6cf1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
.\"     Title: pam_open_session
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
.\"      Date: 04/16/2008
.\"    Manual: Linux-PAM Manual
.\"    Source: Linux-PAM Manual
.\"
.TH "PAM_OPEN_SESSION" "3" "04/16/2008" "Linux-PAM Manual" "Linux-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
pam_open_session - start PAM session management
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <security/pam_appl\.h>
.fi
.ft
.HP 21
.BI "int pam_open_session(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
.SH "DESCRIPTION"
.PP
The
\fBpam_open_session\fR
function sets up a user session for a previously successful authenticated user\. The session should later be terminated with a call to
\fBpam_close_session\fR(3)\.
.PP
It should be noted that the effective uid,
\fBgeteuid\fR(2)\. of the application should be of sufficient privilege to perform such tasks as creating or mounting the user\'s home directory for example\.
.PP
The flags argument is the binary or of zero or more of the following values:
.PP
PAM_SILENT
.RS 4
Do not emit any messages\.
.RE
.SH "RETURN VALUES"
.PP
PAM_ABORT
.RS 4
General failure\.
.RE
.PP
PAM_BUF_ERR
.RS 4
Memory buffer error\.
.RE
.PP
PAM_SESSION_ERR
.RS 4
Session failure\.
.RE
.PP
PAM_SUCCESS
.RS 4
Session was successful created\.
.RE
.SH "SEE ALSO"
.PP

\fBpam_close_session\fR(3),
\fBpam_strerror\fR(3)