granicus.if.org Git - linux-pam/blob - doc/man/pam_sm_acct_mgmt.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 <refentry id='pam_sm_acct_mgmt'>
   5   <refmeta>
   6     <refentrytitle>pam_sm_acct_mgmt</refentrytitle>
   7     <manvolnum>3</manvolnum>
   8     <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
   9   </refmeta>
  10
  11   <refnamediv id="pam_sm_acct_mgmt-name">
  12     <refname>pam_sm_acct_mgmt</refname>
  13     <refpurpose>PAM service function for account management</refpurpose>
  14   </refnamediv>
  15
  16 <!-- body begins here -->
  17
  18   <refsynopsisdiv>
  19     <funcsynopsis id='pam_sm_acct_mgmt-synopsis'>
  20       <funcsynopsisinfo>#define PAM_SM_ACCOUNT</funcsynopsisinfo>
  21       <funcsynopsisinfo>#include &lt;security/pam_modules.h&gt;</funcsynopsisinfo>
  22       <funcprototype>
  23         <funcdef>PAM_EXTERN int <function>pam_sm_acct_mgmt</function></funcdef>
  24         <paramdef>pam_handle_t *<parameter>pamh</parameter></paramdef>
  25         <paramdef>int <parameter>flags</parameter></paramdef>
  26         <paramdef>int <parameter>argc</parameter></paramdef>
  27         <paramdef>const char **<parameter>argv</parameter></paramdef>
  28       </funcprototype>
  29     </funcsynopsis>
  30   </refsynopsisdiv>
  31
  32
  33   <refsect1 id='pam_sm_acct_mgmt-description'>
  34     <title>DESCRIPTION</title>
  35     <para>
  36       The <function>pam_sm_acct_mgmt</function> function is the service
  37       module's implementation of the
  38       <citerefentry>
  39         <refentrytitle>pam_acct_mgmt</refentrytitle><manvolnum>3</manvolnum>
  40       </citerefentry> interface.
  41     </para>
  42     <para>
  43       This function performs the task of establishing whether the user is
  44       permitted to gain access at this time. It should be understood that
  45       the user has previously been validated by an authentication
  46       module. This function checks for other things. Such things might be:
  47       the time of day or the date, the terminal line, remote hostname, etc.
  48       This function may also determine things like the expiration on
  49       passwords, and respond that the user change it before continuing.
  50     </para>
  51     <para>
  52        Valid flags, which may be logically OR'd with
  53        <emphasis>PAM_SILENT</emphasis>, are:
  54     </para>
  55     <variablelist>
  56       <varlistentry>
  57         <term>PAM_SILENT</term>
  58         <listitem>
  59            <para>
  60              Do not emit any messages.
  61           </para>
  62         </listitem>
  63       </varlistentry>
  64       <varlistentry>
  65         <term>PAM_DISALLOW_NULL_AUTHTOK</term>
  66         <listitem>
  67           <para>
  68             Return <emphasis remap='B'>PAM_AUTH_ERR</emphasis> if the
  69             database of authentication tokens for this authentication
  70             mechanism has a <emphasis>NULL</emphasis> entry for the user.
  71           </para>
  72         </listitem>
  73       </varlistentry>
  74     </variablelist>
  75   </refsect1>
  76
  77   <refsect1 id="pam_sm_acct_mgmt-return_values">
  78     <title>RETURN VALUES</title>
  79     <variablelist>
  80       <varlistentry>
  81         <term>PAM_ACCT_EXPIRED</term>
  82         <listitem>
  83            <para>
  84              User account has expired.
  85           </para>
  86         </listitem>
  87       </varlistentry>
  88       <varlistentry>
  89         <term>PAM_AUTH_ERR</term>
  90         <listitem>
  91           <para>
  92             Authentication failure.
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96       <varlistentry>
  97         <term>PAM_NEW_AUTHTOK_REQD</term>
  98         <listitem>
  99           <para>
 100             The user's authentication token has expired. Before calling
 101             this function again the application will arrange for a new
 102             one to be given. This will likely result in a call to
 103             <function>pam_sm_chauthtok()</function>.
 104
 105           </para>
 106         </listitem>
 107       </varlistentry>
 108       <varlistentry>
 109         <term>PAM_PERM_DENIED</term>
 110         <listitem>
 111           <para>
 112             Permission denied.
 113           </para>
 114         </listitem>
 115       </varlistentry>
 116       <varlistentry>
 117         <term>PAM_SUCCESS</term>
 118         <listitem>
 119            <para>
 120              The authentication token was successfully updated.
 121           </para>
 122         </listitem>
 123       </varlistentry>
 124       <varlistentry>
 125         <term>PAM_USER_UNKNOWN</term>
 126         <listitem>
 127           <para>
 128             User unknown to password service.
 129           </para>
 130         </listitem>
 131       </varlistentry>
 132     </variablelist>
 133   </refsect1>
 134
 135   <refsect1 id='pam_sm_acct_mgmt-see_also'>
 136     <title>SEE ALSO</title>
 137     <para>
 138       <citerefentry>
 139         <refentrytitle>pam</refentrytitle><manvolnum>3</manvolnum>
 140       </citerefentry>,
 141       <citerefentry>
 142         <refentrytitle>pam_acct_mgmt</refentrytitle><manvolnum>3</manvolnum>
 143       </citerefentry>,
 144       <citerefentry>
 145         <refentrytitle>pam_sm_chauthtok</refentrytitle><manvolnum>3</manvolnum>
 146       </citerefentry>,
 147       <citerefentry>
 148         <refentrytitle>pam_strerror</refentrytitle><manvolnum>3</manvolnum>
 149       </citerefentry>,
 150       <citerefentry>
 151         <refentrytitle>PAM</refentrytitle><manvolnum>8</manvolnum>
 152       </citerefentry>
 153     </para>
 154   </refsect1>
 155 </refentry>