summaryrefslogtreecommitdiff
path: root/modules/pam_ftp/pam_ftp.8.xml
blob: 6f11f570f38c9f460b34d8e9a86bc9d64752e699 (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='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_ftp">

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

  <refnamediv id="pam_ftp-name">
    <refname>pam_ftp</refname>
    <refpurpose>PAM module for anonymous access module</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_ftp-cmdsynopsis">
      <command>pam_ftp.so</command>
      <arg choice="opt">
	debug
      </arg>
      <arg choice="opt">
        ignore
      </arg>
      <arg choice="opt" rep='repeat'>
        users=<replaceable>XXX,YYY,</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_ftp-description">

    <title>DESCRIPTION</title>

    <para>
      pam_ftp is a PAM module which provides a pluggable
      anonymous ftp mode of access.
    </para>
    <para>
      This module intercepts the user's name and password. If the name is
      <emphasis>ftp</emphasis> or <emphasis>anonymous</emphasis>, the
      user's password is broken up at the <emphasis>@</emphasis> delimiter
      into a <emphasis>PAM_RUSER</emphasis> and a
      <emphasis>PAM_RHOST</emphasis> part; these pam-items being set
      accordingly. The username (<emphasis>PAM_USER</emphasis>) is set
      to <emphasis>ftp</emphasis>.  In this case the module succeeds.
      Alternatively, the module sets the <emphasis>PAM_AUTHTOK</emphasis>
      item with the entered password and fails.
    </para>
    <para>
      This module is not safe and easily spoofable.
    </para>
  </refsect1>

  <refsect1 id="pam_ftp-options">

    <title>OPTIONS</title>
    <para>
      <variablelist>

        <varlistentry>
          <term>
            <option>debug</option>
          </term>
          <listitem>
            <para>
	      Print debug information.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>
            <option>ignore</option>
          </term>
          <listitem>
            <para>
              Pay no attention to the email address of the user
              (if supplied).
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>
            <option>ftp=<replaceable>XXX,YYY,...</replaceable></option>
          </term>
          <listitem>
            <para>
              Instead of <emphasis>ftp</emphasis> or
              <emphasis>anonymous</emphasis>, provide anonymous login
              to the comma separated list of users:
              <option><replaceable>XXX,YYY,...</replaceable></option>.
              Should the applicant enter
              one of these usernames the returned username is set to
              the first in the list: <emphasis>XXX</emphasis>.
            </para>
          </listitem>
	</varlistentry>

      </variablelist>

    </para>
  </refsect1>

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

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

        <varlistentry>
          <term>PAM_SUCCESS</term>
          <listitem>
            <para>
              The authentication was successful.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_USER_UNKNOWN</term>
          <listitem>
            <para>
	      User not known.
            </para>
          </listitem>
        </varlistentry>

      </variablelist>
    </para>
  </refsect1>

  <refsect1 id='pam_ftp-examples'>
    <title>EXAMPLES</title>
    <para>
      Add the following line to <filename>/etc/pam.d/ftpd</filename> to
      handle ftp style anonymous login:
      <programlisting>
#
# ftpd; add ftp-specifics. These lines enable anonymous ftp over
#       standard UN*X access (the listfile entry blocks access to
#       users listed in /etc/ftpusers)
#
auth    sufficient  pam_ftp.so
auth    required    pam_unix.so use_first_pass
auth    required    pam_listfile.so \
           onerr=succeed item=user sense=deny file=/etc/ftpusers
      </programlisting>
    </para>
  </refsect1>

  <refsect1 id='pam_ftp-see_also'>
    <title>SEE ALSO</title>
    <para>
      <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_ftp-author'>
    <title>AUTHOR</title>
      <para>
        pam_ftp was written by Andrew G. Morgan &lt;morgan@kernel.org&gt;.
      </para>
  </refsect1>

</refentry>