summaryrefslogtreecommitdiff
path: root/modules/pam_succeed_if/pam_succeed_if.8.xml
blob: 7bdcb0246586d8441d650088c6953471fa763e2f (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
        "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">


<refentry id='pam_succeed_if'>
<!--  Copyright 2003, 2004 Red Hat, Inc. -->
<!--  Written by Nalin Dahyabhai &lt;nalin@redhat.com&gt; -->

  <refmeta>
    <refentrytitle>pam_succeed_if</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class='sectdesc'>Linux-PAM</refmiscinfo>
  </refmeta>

  <refnamediv id='pam_succeed_if-name'>
    <refname>pam_succeed_if</refname>
    <refpurpose>test account characteristics</refpurpose>
  </refnamediv>


  <refsynopsisdiv>
    <cmdsynopsis id='pam_succeed_if-cmdsynopsis'>
      <command>pam_succeed_if.so</command>
      <arg choice='opt' rep='repeat'><replaceable>flag</replaceable></arg>
      <arg choice='opt' rep='repeat'><replaceable>condition</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>


  <refsect1 id='pam_succeed_if-description'>
    <title>DESCRIPTION</title>
    <para>
      pam_succeed_if.so is designed to succeed or fail authentication
      based on characteristics of the account belonging to the user being
      authenticated or values of other PAM items. One use is to select whether
      to load other modules based on this test.
    </para>

    <para>
      The module should be given one or more conditions as module arguments,
      and authentication will succeed only if all of the conditions are met.
    </para>
  </refsect1>

  <refsect1 id="pam_succeed_if-options">
    <title>OPTIONS</title>
    <para>
      The following <emphasis>flag</emphasis>s are supported:
    </para>

    <variablelist>
      <varlistentry>
        <term><option>debug</option></term>
        <listitem>
          <para>Turns on debugging messages sent to syslog.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>use_uid</option></term>
        <listitem>
          <para>
            Evaluate conditions using the account of the user whose UID
            the application is running under instead of the user being
            authenticated.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>quiet</option></term>
        <listitem>
          <para>Don't log failure or success to the system log.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>quiet_fail</option></term>
        <listitem>
          <para>
            Don't log failure to the system log.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>quiet_success</option></term>
        <listitem>
          <para>
            Don't log success to the system log.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>audit</option></term>
        <listitem>
          <para>
            Log unknown users to the system log.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>

    <para>
      <emphasis>Condition</emphasis>s are three words: a field, a test,
      and a value to test for.
    </para>
    <para>
      Available fields are <emphasis>user</emphasis>,
      <emphasis>uid</emphasis>, <emphasis>gid</emphasis>,
      <emphasis>shell</emphasis>, <emphasis>home</emphasis>,
      <emphasis>ruser</emphasis>, <emphasis>rhost</emphasis>,
      <emphasis>tty</emphasis> and <emphasis>service</emphasis>:
    </para>

    <variablelist>
      <varlistentry>
        <term><option>field &lt; number</option></term>
        <listitem>
          <para>Field has a value numerically less than number.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field &lt;= number</option></term>
        <listitem>
          <para>
            Field has a value numerically less than or equal to number.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field eq number</option></term>
        <listitem>
          <para>
            Field has a value numerically equal to number.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field &gt;= number</option></term>
        <listitem>
          <para>
            Field has a value numerically greater than or equal to number.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field &gt; number</option></term>
        <listitem>
          <para>
            Field has a value numerically greater than number.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field ne number</option></term>
        <listitem>
          <para>
            Field has a value numerically different from number.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field = string</option></term>
        <listitem>
          <para>
            Field exactly matches the given string.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field != string</option></term>
        <listitem>
          <para>
            Field does not match the given string.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field =~ glob</option></term>
        <listitem>
          <para>Field matches the given glob.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field !~ glob</option></term>
        <listitem>
          <para>Field does not match the given glob.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field in item:item:...</option></term>
        <listitem>
          <para>Field is contained in the list of items separated by colons.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>field notin item:item:...</option></term>
        <listitem>
          <para>Field is not contained in the list of items separated by colons.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>user ingroup group</option></term>
        <listitem>
          <para>User is in given group.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>user notingroup group</option></term>
        <listitem>
          <para>User is not in given group.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>user innetgr netgroup</option></term>
        <listitem>
          <para>(user,host) is in given netgroup.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>user notinnetgr group</option></term>
        <listitem>
          <para>(user,host) is not in given netgroup.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_succeed_if-types">
    <title>MODULE TYPES PROVIDED</title>
    <para>
      All module types (<option>account</option>, <option>auth</option>,
      <option>password</option> and <option>session</option>) are provided.
    </para>
  </refsect1>

  <refsect1 id='pam_succeed_if-return_values'>
    <title>RETURN VALUES</title>
     <variablelist>

        <varlistentry>
          <term>PAM_SUCCESS</term>
          <listitem>
            <para>
              The condition was true.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_AUTH_ERR</term>
          <listitem>
            <para>
              The condition was false.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_SERVICE_ERR</term>
          <listitem>
            <para>
              A service error occurred or the arguments can't be
              parsed correctly.
            </para>
          </listitem>
        </varlistentry>
    </variablelist>
  </refsect1>


  <refsect1 id='pam_succeed_if-examples'>
    <title>EXAMPLES</title>
    <para>
      To emulate the behaviour of <emphasis>pam_wheel</emphasis>, except
      there is no fallback to group 0:
    </para>
    <programlisting>
auth required pam_succeed_if.so quiet user ingroup wheel
    </programlisting>

    <para>
      Given that the type matches, only loads the othermodule rule if
      the UID is over 500. Adjust the number after default to skip
      several rules.
    </para>
    <programlisting>
type [default=1 success=ignore] pam_succeed_if.so quiet uid &gt; 500
type required othermodule.so arguments...
    </programlisting>
  </refsect1>

  <refsect1 id='pam_succeed_if-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>

  <refsect1 id='pam_succeed_if-author'>
    <title>AUTHOR</title>
    <para>Nalin Dahyabhai &lt;nalin@redhat.com&gt;</para>
  </refsect1>
</refentry>