xref: /freebsd/contrib/openpam/doc/man/pam_close_session.3 (revision 39ee7a7a6bdd1557b1c3532abf60d139798ac88b)
1.\" Generated from pam_close_session.c by gendoc.pl
2.\" $Id: pam_close_session.c 648 2013-03-05 17:54:27Z des $
3.Dd September 12, 2014
4.Dt PAM_CLOSE_SESSION 3
5.Os
6.Sh NAME
7.Nm pam_close_session
8.Nd close an existing user session
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "int"
15.Fn pam_close_session "pam_handle_t *pamh" "int flags"
16.Sh DESCRIPTION
17The
18.Fn pam_close_session
19function tears down the user session previously
20set up by
21.Xr pam_open_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_close_session
34will return
35.Dv PAM_SYMBOL_ERR .
36.Sh RETURN VALUES
37The
38.Fn pam_close_session
39function returns one of the following values:
40.Bl -tag -width 18n
41.It Bq Er PAM_ABORT
42General failure.
43.It Bq Er PAM_BUF_ERR
44Memory buffer error.
45.It Bq Er PAM_CONV_ERR
46Conversation failure.
47.It Bq Er PAM_PERM_DENIED
48Permission denied.
49.It Bq Er PAM_SERVICE_ERR
50Error in service module.
51.It Bq Er PAM_SESSION_ERR
52Session failure.
53.It Bq Er PAM_SYMBOL_ERR
54Invalid symbol.
55.It Bq Er PAM_SYSTEM_ERR
56System error.
57.El
58.Sh SEE ALSO
59.Xr pam 3 ,
60.Xr pam_open_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_close_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 des@des.no .
81