summaryrefslogtreecommitdiff
path: root/modules/pam_localuser/pam_localuser.8.xml
blob: 4249780c857df451118292a0ed3a64e125264137 (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
<?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_localuser">

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

  <refnamediv id="pam_localuser-name">
    <refname>pam_localuser</refname>
    <refpurpose>require users to be listed in /etc/passwd</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="pam_localuser-cmdsynopsis">
      <command>pam_localuser.so</command>
      <arg choice="opt">
	debug
      </arg>
      <arg choice="opt">
        file=<replaceable>/path/passwd</replaceable>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="pam_localuser-description">

    <title>DESCRIPTION</title>

    <para>
      pam_localuser is a PAM module to help implementing site-wide login
      policies, where they typically include a subset of the network's
      users and a few accounts that are local to a particular workstation.
      Using pam_localuser and pam_wheel or pam_listfile is an effective
      way to restrict access to either local users and/or a subset of the
      network's users.
    </para>
    <para>
      This could also be implemented using pam_listfile.so and a very
      short awk script invoked by cron, but it's common enough to have
      been separated out.
    </para>

  </refsect1>

  <refsect1 id="pam_localuser-options">

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

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

        <varlistentry>
          <term>
            <option>file=<replaceable>/path/passwd</replaceable></option>
          </term>
          <listitem>
            <para>
              Use a file other than <filename>/etc/passwd</filename>.
            </para>
          </listitem>
	</varlistentry>

      </variablelist>

    </para>
  </refsect1>

  <refsect1 id="pam_localuser-services">
    <title>MODULE SERVICES PROVIDED</title>
    <para>
      The <emphasis remap='B'>auth</emphasis> and
      <emphasis remap='B'>account</emphasis> services are supported.
    </para>
  </refsect1>

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

        <varlistentry>
          <term>PAM_SUCCESS</term>
          <listitem>
            <para>
              The new localuser was set successfull.
            </para>
          </listitem>
        </varlistentry>

        <varlistentry>
          <term>PAM_SERVICE_ERR</term>
          <listitem>
            <para>
	      No username was given.
            </para>
          </listitem>
        </varlistentry>

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

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

  <refsect1 id='pam_localuser-examples'>
    <title>EXAMPLES</title>
    <para>
      Add the following line to <filename>/etc/pam.d/su</filename> to
      allow only local users in group wheel to use su.
      <programlisting>
account sufficient pam_localuser.so
account required pam_wheel.so
      </programlisting>
    </para>
  </refsect1>

  <refsect1 id="pam_localuser-files">
    <title>FILES</title>
    <variablelist>
      <varlistentry>
        <term><filename>/etc/passwd</filename></term>
        <listitem>
          <para>Local user account information.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='pam_localuser-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>pam.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_localuser-author'>
    <title>AUTHOR</title>
      <para>
        pam_localuser was written by Nalin Dahyabhai &lt;nalin@redhat.com&gt;.
      </para>
  </refsect1>

</refentry>
<!-- vim: sw=2
-->