xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_close_session.3 (revision 413d532bcc3f62d122e56d92e13ac64825a40baf)
1.\"	$NetBSD: pam_close_session.3,v 1.4 2013/12/27 20:10:20 christos Exp $
2.\"
3.\" Generated from pam_close_session.c by gendoc.pl
4.\" Id: pam_close_session.c 648 2013-03-05 17:54:27Z des
5.Dd September 7, 2013
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 LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.Ft "int"
17.Fn pam_close_session "pam_handle_t *pamh" "int flags"
18.Sh DESCRIPTION
19The
20.Fn pam_close_session
21function tears down the user session previously
22set up by
23.Xr pam_open_session 3 .
24.Pp
25The
26.Fa flags
27argument is the binary or of zero or more of the following
28values:
29.Bl -tag -width 18n
30.It Dv PAM_SILENT
31Do not emit any messages.
32.El
33.Pp
34If any other bits are set,
35.Fn pam_close_session
36will return
37.Dv PAM_SYMBOL_ERR .
38.Sh RETURN VALUES
39The
40.Fn pam_close_session
41function returns one of the following values:
42.Bl -tag -width 18n
43.It Bq Er PAM_ABORT
44General failure.
45.It Bq Er PAM_BUF_ERR
46Memory buffer error.
47.It Bq Er PAM_CONV_ERR
48Conversation failure.
49.It Bq Er PAM_PERM_DENIED
50Permission denied.
51.It Bq Er PAM_SERVICE_ERR
52Error in service module.
53.It Bq Er PAM_SESSION_ERR
54Session failure.
55.It Bq Er PAM_SYMBOL_ERR
56Invalid symbol.
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 des@des.no .
83