freebsd-dev/contrib/openpam/doc/man/pam_end.3
2019-02-25 18:41:16 +00:00

57 lines
1.3 KiB
Groff

.\" Generated from pam_end.c by gendoc.pl
.\" $OpenPAM: pam_end.c 938 2017-04-30 21:34:42Z des $
.Dd February 24, 2019
.Dt PAM_END 3
.Os
.Sh NAME
.Nm pam_end
.Nd terminate the PAM transaction
.Sh SYNOPSIS
.In sys/types.h
.In security/pam_appl.h
.Ft "int"
.Fn pam_end "pam_handle_t *pamh" "int status"
.Sh DESCRIPTION
The
.Fn pam_end
function terminates a PAM transaction and destroys the
corresponding PAM context, releasing all resources allocated to it.
.Pp
The
.Fa status
argument should be set to the error code returned by the
last API call before the call to
.Fn pam_end .
.Sh RETURN VALUES
The
.Fn pam_end
function returns one of the following values:
.Bl -tag -width 18n
.It Bq Er PAM_SUCCESS
Success.
.It Bq Er PAM_BAD_HANDLE
Invalid PAM handle.
.El
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_strerror 3
.Sh STANDARDS
.Rs
.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
.%D "June 1997"
.Re
.Sh AUTHORS
The
.Fn pam_end
function and this manual page were
developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc.\& under
DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
.Pp
The OpenPAM library is maintained by
.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .