granicus.if.org Git - linux-pam/blob - doc/man/pam_close_session.3.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id='pam_send'>
   6
   7   <refmeta>
   8     <refentrytitle>pam_close_session</refentrytitle>
   9     <manvolnum>3</manvolnum>
  10     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_close_session-name">
  14     <refname>pam_close_session</refname>
  15     <refpurpose>terminate PAM session management</refpurpose>
  16   </refnamediv>
  17
  18 <!-- body begins here -->
  19
  20   <refsynopsisdiv>
  21     <funcsynopsis id="pam_close_session-synopsis">
  22       <funcsynopsisinfo>#include &lt;security/pam_appl.h&gt;</funcsynopsisinfo>
  23       <funcprototype>
  24         <funcdef>int <function>pam_close_session</function></funcdef>
  25         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  26         <paramdef>int <parameter>flags</parameter></paramdef>
  27       </funcprototype>
  28     </funcsynopsis>
  29   </refsynopsisdiv>
  30
  31
  32   <refsect1 id="pam_close_session-description">
  33     <title>DESCRIPTION</title>
  34     <para>
  35       The <function>pam_close_session</function> function is used
  36       to indicate that an authenticated session has ended.
  37       The session should have been created with a call to
  38       <citerefentry>
  39         <refentrytitle>pam_open_session</refentrytitle><manvolnum>3</manvolnum>
  40       </citerefentry>.
  41     </para>
  42     <para>
  43       It should be noted that the effective uid,
  44       <citerefentry>
  45         <refentrytitle>geteuid</refentrytitle><manvolnum>2</manvolnum>
  46       </citerefentry>. of the application should be of sufficient
  47       privilege to perform such tasks as unmounting the
  48       user's home directory for example.
  49     </para>
  50     <para>
  51       The flags argument is the binary or of zero or more of the
  52       following values:
  53     </para>
  54     <variablelist>
  55       <varlistentry>
  56         <term>PAM_SILENT</term>
  57         <listitem>
  58            <para>
  59              Do not emit any messages.
  60           </para>
  61         </listitem>
  62       </varlistentry>
  63     </variablelist>
  64   </refsect1>
  65
  66   <refsect1 id="pam_close_session-return_values">
  67     <title>RETURN VALUES</title>
  68     <variablelist>
  69       <varlistentry>
  70         <term>PAM_ABORT</term>
  71         <listitem>
  72            <para>
  73               General failure.
  74           </para>
  75         </listitem>
  76       </varlistentry>
  77       <varlistentry>
  78         <term>PAM_BUF_ERR</term>
  79         <listitem>
  80            <para>
  81               Memory buffer error.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term>PAM_SESSION_ERR</term>
  87         <listitem>
  88            <para>
  89              Session failure.
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93       <varlistentry>
  94         <term>PAM_SUCCESS</term>
  95         <listitem>
  96            <para>
  97              Session was successful terminated.
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101     </variablelist>
 102   </refsect1>
 103
 104   <refsect1 id="pam_close_session-see_also">
 105     <title>SEE ALSO</title>
 106     <para>
 107       <citerefentry>
 108         <refentrytitle>pam_open_session</refentrytitle><manvolnum>3</manvolnum>
 109       </citerefentry>,
 110       <citerefentry>
 111         <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>
 112       </citerefentry>
 113     </para>
 114   </refsect1>
 115 </refentry>