1 <?xml version="1.0" encoding='UTF-8'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
5 <refentry id="pam_sepermit">
8 <refentrytitle>pam_sepermit</refentrytitle>
9 <manvolnum>8</manvolnum>
10 <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
13 <refnamediv id="pam_sepermit-name">
14 <refname>pam_sepermit</refname>
15 <refpurpose>PAM module to allow/deny login depending on SELinux enforcement state</refpurpose>
19 <cmdsynopsis id="pam_sepermit-cmdsynopsis">
20 <command>pam_sepermit.so</command>
25 conf=<replaceable>/path/to/config/file</replaceable>
30 <refsect1 id="pam_sepermit-description">
31 <title>DESCRIPTION</title>
33 The pam_sepermit module allows or denies login depending on SELinux
37 When the user which is logging in matches an entry in the config file
38 he is allowed access only when the SELinux is in enforcing mode. Otherwise
39 he is denied access. For users not matching any entry in the config file
40 the pam_sepermit module returns PAM_IGNORE return value.
43 The config file contains a list of user names one per line with optional arguments. If the
44 <replaceable>name</replaceable> is prefixed with <emphasis>@</emphasis> character it means that all
45 users in the group <replaceable>name</replaceable> match. If it is prefixed
46 with a <emphasis>%</emphasis> character the SELinux user is used to match against the <replaceable>name</replaceable>
47 instead of the account name. Note that when SELinux is disabled the
48 SELinux user assigned to the account cannot be determined. This means that
49 such entries are never matched when SELinux is disabled and pam_sepermit
50 will return PAM_IGNORE.
54 <refentrytitle>sepermit.conf</refentrytitle><manvolnum>5</manvolnum>
55 </citerefentry> for details.
60 <refsect1 id="pam_sepermit-options">
61 <title>OPTIONS</title>
65 <option>debug</option>
69 Turns on debugging via
71 <refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum>
78 <option>conf=<replaceable>/path/to/config/file</replaceable></option>
82 Path to alternative config file overriding the default.
89 <refsect1 id="pam_sepermit-types">
90 <title>MODULE TYPES PROVIDED</title>
92 The <option>auth</option> and <option>account</option>
93 module types are provided.
97 <refsect1 id='pam_sepermit-return_values'>
98 <title>RETURN VALUES</title>
101 <term>PAM_AUTH_ERR</term>
104 SELinux is disabled or in the permissive mode and the user
110 <term>PAM_SUCCESS</term>
113 SELinux is in the enforcing mode and the user matches.
118 <term>PAM_IGNORE</term>
121 The user does not match any entry in the config file.
126 <term>PAM_USER_UNKNOWN</term>
129 The module was unable to determine the user's name.
134 <term>PAM_SERVICE_ERR</term>
137 Error during reading or parsing the config file.
144 <refsect1 id="pam_sepermit-files">
148 <term><filename>/etc/security/sepermit.conf</filename></term>
150 <para>Default configuration file</para>
156 <refsect1 id='pam_sepermit-examples'>
157 <title>EXAMPLES</title>
159 auth [success=done ignore=ignore default=bad] pam_sepermit.so
160 auth required pam_unix.so
161 account required pam_unix.so
162 session required pam_permit.so
166 <refsect1 id='pam_sepermit-see_also'>
167 <title>SEE ALSO</title>
170 <refentrytitle>sepermit.conf</refentrytitle><manvolnum>5</manvolnum>
173 <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
176 <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
179 <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
182 <refentrytitle>selinux</refentrytitle><manvolnum>8</manvolnum>
187 <refsect1 id='pam_sepermit-author'>
188 <title>AUTHOR</title>
190 pam_sepermit and this manual page were written by Tomas Mraz <tmraz@redhat.com>.