contrib/openpam/doc/man/pam_end.3

   1 .\"-
   2 .\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
   3 .\" Copyright (c) 2004-2011 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 .\" $Id$
  36 .\"
  37 .Dd May 26, 2012
  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
  51 The
  52 .Fn pam_end
  53 function terminates a PAM transaction and destroys the
  54 corresponding PAM context, releasing all resources allocated to it.
  55 .Pp
  56 The
  57 .Fa status
  58 argument should be set to the error code returned by the
  59 last API call before the call to
  60 .Fn pam_end .
  61 .Sh RETURN VALUES
  62 The
  63 .Fn pam_end
  64 function returns one of the following values:
  65 .Bl -tag -width 18n
  66 .It Bq Er PAM_SYSTEM_ERR
  67 System error.
  68 .El
  69 .Sh SEE ALSO
  70 .Xr pam 3 ,
  71 .Xr pam_strerror 3
  72 .Sh STANDARDS
  73 .Rs
  74 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  75 .%D "June 1997"
  76 .Re
  77 .Sh AUTHORS
  78 The
  79 .Fn pam_end
  80 function and this manual page were
  81 developed for the
  82 .Fx
  83 Project by ThinkSec AS and Network Associates Laboratories, the
  84 Security Research Division of Network Associates, Inc.\& under
  85 DARPA/SPAWAR contract N66001-01-C-8035
  86 .Pq Dq CBOSS ,
  87 as part of the DARPA CHATS research program.