summaryrefslogtreecommitdiffstats
path: root/modules/pam_faildelay/pam_faildelay.8.xml
blob: 571072036cab6a992e51202f533122c8fb409054 (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
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
	"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">

<refentry id="pam_faildelay">

  <refmeta>
    <refentrytitle>pam_faildelay</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  </refmeta>

  <refnamediv id="pam_faildelay-name">
    <refname>pam_faildelay</refname>
    <refpurpose>Change the delay on failure per-application</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_faildelay-cmdsynopsis">
      <command>pam_faildelay.so</command>
      <arg choice="opt">
        debug
      </arg>
      <arg choice="opt">
        delay=<replaceable>microseconds</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_faildelay-description">

    <title>DESCRIPTION</title>

    <para>
      pam_faildelay is a PAM module that can be used to set
      the delay on failure per-application.
    </para>
    <para>
      If no <option>delay</option> is given, pam_faildelay will
      use the value of FAIL_DELAY from <filename>/etc/login.defs</filename>.
    </para>
  </refsect1>

  <refsect1 id="pam_faildelay-options">

    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term>
          <option>debug</option>
        </term>
        <listitem>
          <para>
            Turns on debugging messages sent to syslog.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>delay=<replaceable>N</replaceable></option>
        </term>
        <listitem>
          <para>
	    Set the delay on failure to N microseconds.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="pam_faildelay-types">
    <title>MODULE TYPES PROVIDED</title>
    <para>
      Only the <option>auth</option> module type is provided.
    </para>
  </refsect1>

  <refsect1 id='pam_faildelay-return_values'>
    <title>RETURN VALUES</title>
    <variablelist>
      <varlistentry>
        <term>PAM_IGNORE</term>
        <listitem>
           <para>
            Delay was successful adjusted.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_SYSTEM_ERR</term>
        <listitem>
          <para>
            The specified delay was not valid.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='pam_faildelay-examples'>
    <title>EXAMPLES</title>
    <para>
      The following example will set the delay on failure to
      10 seconds:
      <programlisting>
auth  optional  pam_faildelay.so  delay=10000000
      </programlisting>
    </para>
  </refsect1>

  <refsect1 id='pam_faildelay-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>pam_fail_delay</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>pam.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 id='pam_faildelay-author'>
    <title>AUTHOR</title>
      <para>
        pam_faildelay was written by Darren Tucker &lt;dtucker@zip.com.au&gt;.
      </para>
  </refsect1>

</refentry>