xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_close_session.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1.\"	$NetBSD: pam_close_session.3,v 1.9 2023/06/30 21:46:20 christos Exp $
2.\"
3.\" Generated from pam_close_session.c by gendoc.pl
4.Dd June 27, 2023
5.Dt PAM_CLOSE_SESSION 3
6.Os
7.Sh NAME
8.Nm pam_close_session
9.Nd close an existing user session
10.Sh SYNOPSIS
11.In sys/types.h
12.In security/pam_appl.h
13.Ft "int"
14.Fn pam_close_session "pam_handle_t *pamh" "int flags"
15.Sh DESCRIPTION
16The
17.Fn pam_close_session
18function tears down the user session previously
19set up by
20.Xr pam_open_session 3 .
21.Pp
22The
23.Fa flags
24argument is the binary or of zero or more of the following
25values:
26.Bl -tag -width 18n
27.It Dv PAM_SILENT
28Do not emit any messages.
29.El
30.Pp
31If any other bits are set,
32.Fn pam_close_session
33will return
34.Dv PAM_BAD_CONSTANT .
35.Sh RETURN VALUES
36The
37.Fn pam_close_session
38function returns one of the following values:
39.Bl -tag -width 18n
40.It Bq Er PAM_SUCCESS
41Success.
42.It Bq Er PAM_ABORT
43General failure.
44.It Bq Er PAM_BAD_CONSTANT
45Bad constant.
46.It Bq Er PAM_BUF_ERR
47Memory buffer error.
48.It Bq Er PAM_CONV_ERR
49Conversation failure.
50.It Bq Er PAM_PERM_DENIED
51Permission denied.
52.It Bq Er PAM_SERVICE_ERR
53Error in service module.
54.It Bq Er PAM_SESSION_ERR
55Session failure.
56.It Bq Er PAM_SYSTEM_ERR
57System error.
58.El
59.Sh SEE ALSO
60.Xr pam 3 ,
61.Xr pam_open_session 3 ,
62.Xr pam_strerror 3
63.Sh STANDARDS
64.Rs
65.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
66.%D "June 1997"
67.Re
68.Sh AUTHORS
69The
70.Fn pam_close_session
71function and this manual page were
72developed for the
73.Fx
74Project by ThinkSec AS and Network Associates Laboratories, the
75Security Research Division of Network Associates, Inc.\& under
76DARPA/SPAWAR contract N66001-01-C-8035
77.Pq Dq CBOSS ,
78as part of the DARPA CHATS research program.
79.Pp
80The OpenPAM library is maintained by
81.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
82