summaryrefslogtreecommitdiff
path: root/modules/pam_time/pam_time.8.xml
blob: e0b149a7c012342028be666bed88fcd2c4114c04 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id='pam_time'>

  <refmeta>
    <refentrytitle>pam_time</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class='setdesc'>Linux-PAM Manual</refmiscinfo>
  </refmeta>

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

<!-- body begins here -->

  <refsynopsisdiv>
    <cmdsynopsis id="pam_time-cmdsynopsis">
      <command>pam_time.so</command>
      <arg choice="opt">
        debug
      </arg>
      <arg choice="opt">
        noaudit
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>


  <refsect1 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>.
    </para>
    <para>
      If Linux PAM is compiled with audit support the module will report
      when it denies access. 
    </para>
  </refsect1>

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

      <varlistentry>
        <term>
          <option>debug</option>
        </term>
        <listitem>
          <para>
            Some debug informations are printed with
            <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
          </para>
        </listitem>
      </varlistentry>

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

    </variablelist>
  </refsect1>

  <refsect1 id="pam_time-services">
    <title>MODULE SERVICES PROVIDED</title>
    <para>
      Only the <option>account</option> service is supported.
    </para>
  </refsect1>

  <refsect1 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 id="pam_time-files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>/etc/security/time.conf</filename></term>
        <listitem>
          <para>Default configuration file</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 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 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>8</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>.
    </para>
  </refsect1>

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