summaryrefslogtreecommitdiff
path: root/modules/pam_securetty/pam_securetty.8.xml
blob: 48215f5ffe97d4d9b08186e099c2ace88f764376 (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_securetty">

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

  <refnamediv id="pam_securetty-name">
    <refname>pam_securetty</refname>
    <refpurpose>Limit root login to special devices</refpurpose>
  </refnamediv>

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

  <refsect1 id="pam_securetty-description">

    <title>DESCRIPTION</title>

    <para>
      pam_securetty is a PAM module that allows root logins only if the
      user is logging in on a "secure" tty, as defined by the listing
      in <filename>/etc/securetty</filename>. pam_securetty also checks
      to make sure that <filename>/etc/securetty</filename> is a plain
      file and not world writable. It will also allow root logins on
      the tty specified with <option>console=</option> switch on the
      kernel command line and on ttys from the
      <filename>/sys/class/tty/console/active</filename>.
    </para>
    <para>
      This module has no effect on non-root users and requires that the
      application fills in the <emphasis remap='B'>PAM_TTY</emphasis>
      item correctly.
    </para>
    <para>
      For canonical usage, should be listed as a
      <emphasis remap='B'>required</emphasis> authentication method
      before any <emphasis remap='B'>sufficient</emphasis>
      authentication methods.
    </para>
  </refsect1>

  <refsect1 id="pam_securetty-options">
    <title>OPTIONS</title>
        <variablelist>
      <varlistentry>
        <term>
          <option>debug</option>
        </term>
        <listitem>
          <para>
            Print debug information.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>noconsole</option>
        </term>
        <listitem>
          <para>
            Do not automatically allow root logins on the kernel console
            device, as specified on the kernel command line or by the sys file,
            if it is not also specified in the
            <filename>/etc/securetty</filename> file.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

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

  <refsect1 id='pam_securetty-return_values'>
    <title>RETURN VALUES</title>
    <variablelist>
      <varlistentry>
        <term>PAM_SUCCESS</term>
        <listitem>
          <para>
            The user is allowed to continue authentication.
            Either the user is not root, or the root user is
            trying to log in on an acceptable device.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_AUTH_ERR</term>
        <listitem>
          <para>
            Authentication is rejected. Either root is attempting to
            log in via an unacceptable device, or the
            <filename>/etc/securetty</filename> file is world writable or
            not a normal file.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_INCOMPLETE</term>
        <listitem>
          <para>
            An application error occurred. pam_securetty was not able
            to get information it required from the application that
            called it.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_SERVICE_ERR</term>
        <listitem>
          <para>
            An error occurred while the module was determining the
            user's name or tty, or the module could not open
            <filename>/etc/securetty</filename>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>PAM_USER_UNKNOWN</term>
        <listitem>
          <para>
            The module could not find the user name in the
            <filename>/etc/passwd</filename> file to verify whether
            the user had a UID of 0. Therefore, the results of running
            this module are ignored.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id='pam_securetty-examples'>
    <title>EXAMPLES</title>
    <para>
      <programlisting>
auth  required  pam_securetty.so
auth  required  pam_unix.so
      </programlisting>
    </para>
  </refsect1>

  <refsect1 id='pam_securetty-see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>securetty</refentrytitle><manvolnum>5</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_securetty-author'>
    <title>AUTHOR</title>
      <para>
        pam_securetty was written by Elliot Lee &lt;sopwith@cuc.edu&gt;.
      </para>
  </refsect1>

</refentry>