xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_close_session.3 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: pam_close_session.3,v 1.7 2017/05/06 19:50:09 christos Exp $
2.\"
3.\" Generated from pam_close_session.c by gendoc.pl
4.\" $OpenPAM: pam_close_session.c 938 2017-04-30 21:34:42Z des $
5.Dd April 30, 2017
6.Dt PAM_CLOSE_SESSION 3
7.Os
8.Sh NAME
9.Nm pam_close_session
10.Nd close an existing user session
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_BAD_CONSTANT .
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_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_open_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_close_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