summaryrefslogtreecommitdiff
path: root/doc/man/pam_close_session.3
blob: d48ed570f7c1553f1412dd9e4eda8140a0bc1d08 (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
.\"     Title: pam_close_session
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
.\"      Date: 06/25/2006
.\"    Manual: Linux\-PAM Manual
.\"    Source: Linux\-PAM Manual
.\"
.TH "PAM_CLOSE_SESSION" "3" "06/25/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
pam_close_session \- terminate PAM session management
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <security/pam_appl.h>
.fi
.ft
.HP 22
.BI "int pam_close_session(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
.SH "DESCRIPTION"
.PP
The
\fBpam_close_session\fR
function is used to indicate that an authenticated session has ended. The session should have been created with a call to
\fBpam_open_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 unmounting the user's home directory for example.
.PP
The flags argument is the binary or of zero or more of the following values:
.TP 3n
PAM_SILENT
Do not emit any messages.
.SH "RETURN VALUES"
.TP 3n
PAM_ABORT
General failure.
.TP 3n
PAM_BUF_ERR
Memory buffer error.
.TP 3n
PAM_SESSION_ERR
Session failure.
.TP 3n
PAM_SUCCESS
Session was successful terminated.
.SH "SEE ALSO"
.PP

\fBpam_open_session\fR(3),
\fBpam_strerror\fR(3)