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