xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_end.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1.\"	$NetBSD: pam_end.3,v 1.9 2023/06/30 21:46:20 christos Exp $
2.\"
3.\" Generated from pam_end.c by gendoc.pl
4.Dd June 27, 2023
5.Dt PAM_END 3
6.Os
7.Sh NAME
8.Nm pam_end
9.Nd terminate the PAM transaction
10.Sh SYNOPSIS
11.In sys/types.h
12.In security/pam_appl.h
13.Ft "int"
14.Fn pam_end "pam_handle_t *pamh" "int status"
15.Sh DESCRIPTION
16The
17.Fn pam_end
18function terminates a PAM transaction and destroys the
19corresponding PAM context, releasing all resources allocated to it.
20.Pp
21The
22.Fa status
23argument should be set to the error code returned by the
24last API call before the call to
25.Fn pam_end .
26.Sh RETURN VALUES
27The
28.Fn pam_end
29function returns one of the following values:
30.Bl -tag -width 18n
31.It Bq Er PAM_SUCCESS
32Success.
33.It Bq Er PAM_BAD_HANDLE
34Invalid PAM handle.
35.El
36.Sh SEE ALSO
37.Xr pam 3 ,
38.Xr pam_strerror 3
39.Sh STANDARDS
40.Rs
41.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
42.%D "June 1997"
43.Re
44.Sh AUTHORS
45The
46.Fn pam_end
47function and this manual page were
48developed for the
49.Fx
50Project by ThinkSec AS and Network Associates Laboratories, the
51Security Research Division of Network Associates, Inc.\& under
52DARPA/SPAWAR contract N66001-01-C-8035
53.Pq Dq CBOSS ,
54as part of the DARPA CHATS research program.
55.Pp
56The OpenPAM library is maintained by
57.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
58