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