<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_time">

  <refmeta>
    <refentrytitle>pam_time</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="source">Linux-PAM</refmiscinfo>
    <refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv xml:id="pam_time-name">
    <refname>pam_time</refname>
    <refpurpose>
      PAM module for time control access
    </refpurpose>
  </refnamediv>

<!-- body begins here -->

  <refsynopsisdiv>
    <cmdsynopsis xml:id="pam_time-cmdsynopsis" sepchar=" ">
      <command>pam_time.so</command>
      <arg choice="opt" rep="norepeat">
	conffile=conf-file
      </arg>
      <arg choice="opt" rep="norepeat">
        debug
      </arg>
      <arg choice="opt" rep="norepeat">
        noaudit
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>


  <refsect1 xml:id="pam_time-description">
    <title>DESCRIPTION</title>
    <para>
      The pam_time PAM module does not authenticate the user, but instead
      it restricts access to a system and or specific applications at
      various times of the day and on specific days or over various
      terminal lines. This module can be configured to deny access to
      (individual) users based on their name, the time of day, the day of
      week, the service they are applying for and their terminal from which
      they are making their request.
    </para>
    <para>
      By default rules for time/port access are taken from config file
      <filename>/etc/security/time.conf</filename>.
      An alternative file can be specified with the <emphasis>conffile</emphasis> option.
    </para>
    <para condition="with_vendordir">
      If there is no explicitly specified configuration file and
      <filename>/etc/security/time.conf</filename> does not exist,
      <filename>%vendordir%/security/time.conf</filename> is used.
    </para>
    <para>
      If Linux PAM is compiled with audit support the module will report
      when it denies access.
    </para>
  </refsect1>

  <refsect1 xml:id="pam_time-options">
    <title>OPTIONS</title>
    <variablelist>

     <varlistentry>
	<term>
	  conffile=/path/to/time.conf
        </term>
        <listitem>
	  <para>
            Indicate an alternative time.conf style configuration file to override the default.
	  </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          debug
        </term>
        <listitem>
          <para>
            Some debug information is printed with
            <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          noaudit
        </term>
        <listitem>
          <para>
            Do not report logins at disallowed time to the audit subsystem.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1 xml:id="pam_time-types">
    <title>MODULE TYPES PROVIDED</title>
    <para>
      Only the <option>account</option> type is provided.
    </para>
  </refsect1>

  <refsect1 xml:id="pam_time-return_values">
    <title>RETURN VALUES</title>
    <variablelist>
      <varlistentry>
        <term>PAM_SUCCESS</term>
        <listitem>
           <para>
             Access was granted.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_ABORT</term>
        <listitem>
           <para>
             Not all relevant data could be gotten.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_BUF_ERR</term>
        <listitem>
          <para>
            Memory buffer error.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_PERM_DENIED</term>
        <listitem>
          <para>
            Access was not granted.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_USER_UNKNOWN</term>
        <listitem>
           <para>
             The user is not known to the system.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 xml:id="pam_time-files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term>/etc/security/time.conf</term>
        <listitem>
          <para>Default configuration file</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 xml:id="pam_time-examples">
    <title>EXAMPLES</title>
      <programlisting>
#%PAM-1.0
#
# apply pam_time accounting to login requests
#
login  account  required  pam_time.so
      </programlisting>
  </refsect1>

  <refsect1 xml:id="pam_time-see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>time.conf</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

  <refsect1 xml:id="pam_time-authors">
    <title>AUTHOR</title>
    <para>
      pam_time was written by Andrew G. Morgan &lt;morgan@kernel.org&gt;.
    </para>
  </refsect1>
</refentry>