xref: /freebsd/contrib/openpam/doc/man/pam_close_session.3 (revision 282a3889ebf826db9839be296ff1dd903f6d6d6e)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" Network Associates Laboratories, the Security Research Division of
7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8.\" ("CBOSS"), as part of the DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4$
35.\"
36.Dd June 16, 2005
37.Dt PAM_CLOSE_SESSION 3
38.Os
39.Sh NAME
40.Nm pam_close_session
41.Nd close an existing user session
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In sys/types.h
46.In security/pam_appl.h
47.Ft "int"
48.Fn pam_close_session "pam_handle_t *pamh" "int flags"
49.Sh DESCRIPTION
50The
51.Nm
52function tears down the user session previously
53set up by
54.Xr pam_open_session 3 .
55.Pp
56The
57.Fa flags
58argument is the binary or of zero or more of the following
59values:
60.Bl -tag -width 18n
61.It Dv PAM_SILENT
62Do not emit any messages.
63.El
64.Pp
65If any other bits are set,
66.Nm
67will return
68.Dv PAM_SYMBOL_ERR .
69.Sh RETURN VALUES
70The
71.Nm
72function returns one of the following values:
73.Bl -tag -width 18n
74.It Bq Er PAM_ABORT
75General failure.
76.It Bq Er PAM_BUF_ERR
77Memory buffer error.
78.It Bq Er PAM_CONV_ERR
79Conversation failure.
80.It Bq Er PAM_PERM_DENIED
81Permission denied.
82.It Bq Er PAM_SERVICE_ERR
83Error in service module.
84.It Bq Er PAM_SESSION_ERR
85Session failure.
86.It Bq Er PAM_SYMBOL_ERR
87Invalid symbol.
88.It Bq Er PAM_SYSTEM_ERR
89System error.
90.El
91.Sh SEE ALSO
92.Xr pam 3 ,
93.Xr pam_open_session 3 ,
94.Xr pam_strerror 3
95.Sh STANDARDS
96.Rs
97.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
98.%D "June 1997"
99.Re
100.Sh AUTHORS
101The
102.Nm
103function and this manual page were developed for the
104.Fx
105Project by ThinkSec AS and Network Associates Laboratories, the
106Security Research Division of Network Associates, Inc.\& under
107DARPA/SPAWAR contract N66001-01-C-8035
108.Pq Dq CBOSS ,
109as part of the DARPA CHATS research program.
110