summaryrefslogtreecommitdiff
path: root/src/man/sssd-simple.5.xml
blob: fd3b8b0e29aa440e2b22ab5627ee94673404f751 (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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />

    <refmeta>
        <refentrytitle>sssd-simple</refentrytitle>
        <manvolnum>5</manvolnum>
        <refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
    </refmeta>

    <refnamediv id='name'>
        <refname>sssd-simple</refname>
        <refpurpose>the configuration file for SSSD's 'simple' access-control
            provider</refpurpose>
    </refnamediv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            This manual page describes the configuration of the simple
            access-control provider for
            <citerefentry>
                <refentrytitle>sssd</refentrytitle>
                <manvolnum>8</manvolnum>
            </citerefentry>.
            For a detailed syntax reference, refer to the
            <quote>FILE FORMAT</quote> section of the
            <citerefentry>
                <refentrytitle>sssd.conf</refentrytitle>
                <manvolnum>5</manvolnum>
            </citerefentry> manual page.
        </para>
        <para>
            The simple access provider grants or denies access based on an
            access or deny list of user or group names. The following rules
            apply:
            <itemizedlist>
                <listitem>
                    <para>If all lists are empty, access is granted</para>
                </listitem>
                <listitem>
                    <para>
                        If any list is provided, the order of evaluation is
                        allow,deny. This means that any matching deny rule
                        will supersede any matched allow rule.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        If either or both "allow" lists are provided, all
                        users are denied unless they appear in the list.
                    </para>
                </listitem>
                <listitem>
                    <para>
                        If only "deny" lists are provided, all users are
                        granted access unless they appear in the list.
                    </para>
                </listitem>
            </itemizedlist>
        </para>
    </refsect1>

    <refsect1 id='file-format'>
        <title>CONFIGURATION OPTIONS</title>
        <para>Refer to the section <quote>DOMAIN SECTIONS</quote> of the
            <citerefentry>
                <refentrytitle>sssd.conf</refentrytitle>
                <manvolnum>5</manvolnum>
            </citerefentry> manual page for details on the configuration of an
            SSSD domain.
            <variablelist>
                <varlistentry>
                    <term>simple_allow_users (string)</term>
                    <listitem>
                        <para>
                            Comma separated list of users who are allowed to
                            log in.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>simple_deny_users (string)</term>
                    <listitem>
                        <para>
                            Comma separated list of users who are explicitly
                            denied access.
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>simple_allow_groups (string)</term>
                    <listitem>
                        <para>
                            Comma separated list of groups that are allowed to
                            log in. This applies only to groups within this
                            SSSD domain. Local groups are not evaluated.
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>simple_deny_groups (string)</term>
                    <listitem>
                        <para>
                            Comma separated list of groups that are explicitly
                            denied access. This applies only to groups within
                            this SSSD domain. Local groups are not evaluated.
                        </para>
                    </listitem>
                </varlistentry>
            </variablelist>
        </para>
        <para>
            Please note that it is an configuration error if both,
            simple_allow_users and simple_deny_users, are defined.
        </para>
    </refsect1>

    <refsect1 id='example'>
        <title>EXAMPLE</title>
        <para>
            The following example assumes that SSSD is correctly
            configured and example.com is one of the domains in the
            <replaceable>[sssd]</replaceable> section. This examples shows only
            the simple access provider-specific options.
        </para>
        <para>
<programlisting>
    [domain/example.com]
    access_provider = simple
    simple_allow_users = user1, user2
</programlisting>
        </para>
    </refsect1>

    <refsect1 id='see_also'>
        <title>SEE ALSO</title>
        <para>
            <citerefentry>
                <refentrytitle>sssd.conf</refentrytitle><manvolnum>5</manvolnum>
            </citerefentry>,
            <citerefentry>
                <refentrytitle>sssd</refentrytitle><manvolnum>8</manvolnum>
            </citerefentry>
        </para>
    </refsect1>
</refentry>
</reference>