contrib/openpam/doc/man/pam_close_session.3

   1 .\" Generated from pam_close_session.c by gendoc.pl
   2 .\" $OpenPAM: pam_close_session.c 938 2017-04-30 21:34:42Z des $
   3 .Dd February 24, 2019
   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_BAD_CONSTANT .
  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_SUCCESS
  40 Success.
  41 .It Bq Er PAM_ABORT
  42 General failure.
  43 .It Bq Er PAM_BAD_CONSTANT
  44 Bad constant.
  45 .It Bq Er PAM_BUF_ERR
  46 Memory buffer error.
  47 .It Bq Er PAM_CONV_ERR
  48 Conversation failure.
  49 .It Bq Er PAM_PERM_DENIED
  50 Permission denied.
  51 .It Bq Er PAM_SERVICE_ERR
  52 Error in service module.
  53 .It Bq Er PAM_SESSION_ERR
  54 Session failure.
  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 Mt des@des.no .