xref: /freebsd/contrib/openpam/doc/man/pam_end.3 (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" Copyright (c) 2004-2007 Dag-Erling Smørgrav
4.\" All rights reserved.
5.\"
6.\" This software was developed for the FreeBSD Project by ThinkSec AS and
7.\" Network Associates Laboratories, the Security Research Division of
8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
9.\" ("CBOSS"), as part of the DARPA CHATS research program.
10.\"
11.\" Redistribution and use in source and binary forms, with or without
12.\" modification, are permitted provided that the following conditions
13.\" are met:
14.\" 1. Redistributions of source code must retain the above copyright
15.\"    notice, this list of conditions and the following disclaimer.
16.\" 2. Redistributions in binary form must reproduce the above copyright
17.\"    notice, this list of conditions and the following disclaimer in the
18.\"    documentation and/or other materials provided with the distribution.
19.\" 3. The name of the author may not be used to endorse or promote
20.\"    products derived from this software without specific prior written
21.\"    permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\" $P4$
36.\"
37.Dd December 21, 2007
38.Dt PAM_END 3
39.Os
40.Sh NAME
41.Nm pam_end
42.Nd terminate the PAM transaction
43.Sh LIBRARY
44.Lb libpam
45.Sh SYNOPSIS
46.In sys/types.h
47.In security/pam_appl.h
48.Ft "int"
49.Fn pam_end "pam_handle_t *pamh" "int status"
50.Sh DESCRIPTION
51The
52.Nm
53function terminates a PAM transaction and destroys the
54corresponding PAM context, releasing all resources allocated to it.
55.Pp
56The
57.Fa status
58argument should be set to the error code returned by the
59last API call before the call to
60.Nm
61.
62.Sh RETURN VALUES
63The
64.Nm
65function returns one of the following values:
66.Bl -tag -width 18n
67.It Bq Er PAM_SYSTEM_ERR
68System error.
69.El
70.Sh SEE ALSO
71.Xr pam 3 ,
72.Xr pam_strerror 3
73.Sh STANDARDS
74.Rs
75.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
76.%D "June 1997"
77.Re
78.Sh AUTHORS
79The
80.Nm
81function and this manual page were developed for the
82.Fx
83Project by ThinkSec AS and Network Associates Laboratories, the
84Security Research Division of Network Associates, Inc.\& under
85DARPA/SPAWAR contract N66001-01-C-8035
86.Pq Dq CBOSS ,
87as part of the DARPA CHATS research program.
88