contrib/openpam/doc/man/pam_close_session.3

   1 .\" Generated from pam_close_session.c by gendoc.pl
   2 .\" $Id: pam_close_session.c 648 2013-03-05 17:54:27Z des $
   3 .Dd September 7, 2013
   4 .Dt PAM_CLOSE_SESSION 3
   5 .Os
   6 .Sh NAME
   7 .Nm pam_close_session
   8 .Nd close an existing user session
   9 .Sh LIBRARY
  10 .Lb libpam
  11 .Sh SYNOPSIS
  12 .In sys/types.h
  13 .In security/pam_appl.h
  14 .Ft "int"
  15 .Fn pam_close_session "pam_handle_t *pamh" "int flags"
  16 .Sh DESCRIPTION
  17 The
  18 .Fn pam_close_session
  19 function tears down the user session previously
  20 set up by
  21 .Xr pam_open_session 3 .
  22 .Pp
  23 The
  24 .Fa flags
  25 argument is the binary or of zero or more of the following
  26 values:
  27 .Bl -tag -width 18n
  28 .It Dv PAM_SILENT
  29 Do not emit any messages.
  30 .El
  31 .Pp
  32 If any other bits are set,
  33 .Fn pam_close_session
  34 will return
  35 .Dv PAM_SYMBOL_ERR .
  36 .Sh RETURN VALUES
  37 The
  38 .Fn pam_close_session
  39 function returns one of the following values:
  40 .Bl -tag -width 18n
  41 .It Bq Er PAM_ABORT
  42 General failure.
  43 .It Bq Er PAM_BUF_ERR
  44 Memory buffer error.
  45 .It Bq Er PAM_CONV_ERR
  46 Conversation failure.
  47 .It Bq Er PAM_PERM_DENIED
  48 Permission denied.
  49 .It Bq Er PAM_SERVICE_ERR
  50 Error in service module.
  51 .It Bq Er PAM_SESSION_ERR
  52 Session failure.
  53 .It Bq Er PAM_SYMBOL_ERR
  54 Invalid symbol.
  55 .It Bq Er PAM_SYSTEM_ERR
  56 System error.
  57 .El
  58 .Sh SEE ALSO
  59 .Xr pam 3 ,
  60 .Xr pam_open_session 3 ,
  61 .Xr pam_strerror 3
  62 .Sh STANDARDS
  63 .Rs
  64 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
  65 .%D "June 1997"
  66 .Re
  67 .Sh AUTHORS
  68 The
  69 .Fn pam_close_session
  70 function and this manual page were
  71 developed for the
  72 .Fx
  73 Project by ThinkSec AS and Network Associates Laboratories, the
  74 Security Research Division of Network Associates, Inc.\& under
  75 DARPA/SPAWAR contract N66001-01-C-8035
  76 .Pq Dq CBOSS ,
  77 as part of the DARPA CHATS research program.
  78 .Pp
  79 The OpenPAM library is maintained by
  80 .An Dag-Erling Sm\(/orgrav Aq des@des.no .