4f7a0869defca393fa194d6f5542d8cf840e3742
[samba.git] / docs / docbook / projdoc / GROUP-MAPPING-HOWTO.xml
1 <?xml version="1.0" encoding="iso8859-1"?>
2 <chapter id="groupmapping">
3 <chapterinfo>
4         <author>
5                 <firstname>Jean Fran├žois</firstname><surname>Micouleau</surname>
6         </author>
7         &author.jerry;
8         &author.jht;
9 </chapterinfo>
10 <title>Mapping MS Windows and Unix Groups</title>
11
12         <para>
13         Starting with Samba-3, new group mapping functionality is available to create associations
14         between Windows group SIDs and UNIX groups. The <parameter>groupmap</parameter> subcommand
15         included with the &net; tool can be used to manage these associations.
16         </para>
17
18         <warning>
19         <para>
20         The first immediate reason to use the group mapping on a Samba PDC, is that
21         the <parameter>domain admin group</parameter> has been removed and should no longer
22         be specified in &smb.conf;. This parameter was used to give the listed users membership
23         in the "Domain Admins" Windows group which gave local admin rights on their workstations
24         (in default configurations).
25         </para>
26         </warning>
27
28 <sect1>
29 <title>Features and Benefits</title>
30
31         <para>
32         Samba allows the administrator to create MS Windows NT4 / 200x group accounts and to
33         arbitrarily associate them with Unix/Linux group accounts.
34         </para>
35
36         <para>
37         Group accounts can be managed using the MS Windows NT4 or MS Windows 200x MMC tools
38         so long as appropriate interface scripts have been provided to &smb.conf;
39         </para>
40
41         <para>
42         Administrators should be aware that where &smb.conf; group interface scripts make
43         direct calls to the Unix/Linux system tools (eg: the shadow utilities, <command>groupadd,
44         groupdel, groupmod</command>) then the resulting Unix/Linux group names will be subject
45         to any limits imposed by these tools. If the tool does NOT allow upper case characters
46         or space characters, then the creation of an MS Windows NT4 / 200x style group of
47         <parameter>Engineering Managers</parameter> will attempt to create an identically named
48         Unix/Linux group, an attempt that will of course fail!
49         </para>
50
51         <para>
52         There are several possible work-arounds for the operating system tools limitation. One
53         method is to use a script that generates a name for the Unix/Linux system group that
54         fits the operating system limits, and that then just passes the Unix/Linux group id (GID)
55         back to the calling samba interface. This will provide a dynamic work-around solution.
56         </para>
57
58         <para>
59         Another work-around is to manually create a Unix/Linux group, then manually create the
60         MS Windows NT4 / 200x group on the Samba server and then use the <command>net groupmap</command>
61         tool to connect the two to each other.
62         </para>
63
64 </sect1>
65
66 <sect1>
67 <title>Discussion</title>
68
69         <para>
70         When installing MS Windows NT4 / 200x on a computer, the installation program creates default
71         users and groups. Notably the 'Administrators' group, and gives to that group privileges necessary
72         privilidges to perform essential system tasks. eg: Ability to change the date and time or to
73         kill any process (or close too) running on the local machine.
74         </para>
75         
76         <para>
77         The 'Administrator' user is a member of the 'Administrators' group, and thus inherits
78         'Administrators' group privileges. If a 'joe' user is created to be a member of the
79         'Administrator' group, 'joe' has exactly the same rights as 'Administrator'.
80         </para>
81
82         <para>
83         When an MS Windows NT4 / W200x is made a domain member, the "Domain Adminis" group of the
84         PDC is added to the local 'Administrators' group of the workstation. Every member of the
85         'Domain Administrators' group inherits the rights of the local 'Administrators' group when
86         logging on the workstation.
87         </para>
88
89         <para>
90         The following steps describe how to make samba PDC users members of the 'Domain Admins' group?
91         </para>
92
93         <orderedlist>
94                 <listitem><para>
95                 create a unix group (usually in <filename>/etc/group</filename>), let's call it domadm
96                 </para></listitem>
97
98                 <listitem><para>add to this group the users that must be Administrators. For example
99                 if you want joe,john and mary, your entry in <filename>/etc/group</filename> will
100                 look like:
101                 </para>
102
103                 <para><screen>
104                 domadm:x:502:joe,john,mary
105                 </screen>
106                 </para></listitem>
107
108                 <listitem><para>
109                 Map this domadm group to the "Domain Admins" group by running the command:
110                 </para>
111
112                 <para>
113                 <screen>
114                 &rootprompt;<userinput>net groupmap add ntgroup="Domain Admins" unixgroup=domadm</userinput>
115                 </screen>
116                 </para>
117                 
118                 <para>
119                 The quotes around "Domain Admins" are necessary due to the space in the group name.
120                 Also make sure to leave no whitespace surrounding the equal character (=).
121                 </para></listitem>
122         </orderedlist>
123
124         <para>
125         Now joe, john and mary are domain administrators!
126         </para>
127
128         <para>
129         It is possible to map any arbitrary UNIX group to any Windows NT4 / 200x group as well as
130         making any UNIX group a Windows domain group.  For example, if you wanted to include a
131         UNIX group (e.g. acct) in a ACL on a local file or printer on a domain member machine,
132         you would flag that group as a domain group by running the following on the Samba PDC:
133         </para>
134
135         <para>
136         <screen>
137         &rootprompt;<userinput>net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct</userinput>
138         </screen>
139         </para>
140
141         <para>
142         Be aware that the RID parmeter is a unsigned 32 bit integer that should
143         normally start at 1000.  However, this rid must not overlap with any RID assigned
144         to a user.  Verifying this is done differently depending on on the passdb backend 
145         you are using.  Future versions of the tools may perform the verification automatically,
146         but for now the burden is on you.
147         </para>
148
149         <sect2>
150         <title>Example Configuration</title>
151
152                 <para>
153                 You can list the various groups in the mapping database by executing 
154                 <command>net groupmap list</command>.  Here is an example:
155                 </para>
156
157                 <para>
158                 <screen>&rootprompt; net groupmap list
159                 System Administrators (S-1-5-21-2547222302-1596225915-2414751004-1002) -> sysadmin
160                 Domain Admins (S-1-5-21-2547222302-1596225915-2414751004-512) -> domadmin
161                 Domain Users (S-1-5-21-2547222302-1596225915-2414751004-513) -> domuser
162                 Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest
163                 </screen>
164                 </para>
165
166                 <para>
167                 For complete details on <command>net groupmap</command>, refer to the net(8) man page.
168                 </para>
169
170         </sect2>
171
172 </sect1>
173
174 <sect1>
175 <title>Configuration Scripts</title>
176
177         <para>
178         Everyone needs tools. Some of us like to create our own, others prefer to use canned tools
179         (ie: prepared by someone else for general use). 
180         </para>
181
182         <sect2>
183         <title>Sample smb.conf add group script</title>
184
185                 <para>
186                 A script to great complying group names for use by the samba group interfaces:
187                 </para>
188
189 <para>
190 <screen>
191 Script name: smbgrpadd.sh
192
193 #!/bin/bash
194
195 # Add the group using normal system groupadd tool.
196 groupadd smbtmpgrp00
197
198 thegid=`cat /etc/group | grep smbtmpgrp00 | cut -d ":" -f3`
199
200 # Now change the name to what we want for the MS Windows networking end
201 cat /etc/group | sed s/smbtmpgrp00/$1/g > /etc/group
202
203 # Now return the GID as would normally happen.
204 echo $thegid
205 exit 0
206 </screen>
207 </para>
208
209                 <para>
210                 The &smb.conf; entry for the above script would look like:
211                 <screen>
212                 add group script = /path_to_tool/smbgrpadd.sh %g
213                 </screen>
214                 </para>
215
216         </sect2>
217         
218         <sect2>
219         <title>Script to configure Group Mapping</title>
220
221         <para>
222         In our example we have created a Unix/Linux group called <parameter>ntadmin</parameter>.
223         Our script will create the additional groups <parameter>Engineers, Marketoids, Gnomes</parameter>:
224         </para>
225
226 <para>
227 <screen>
228 #!/bin/bash
229
230 net groupmap modify ntgroup="Domain Admins" unixgroup=ntadmin
231 net groupmap modify ntgroup="Domain Users" unixgroup=users
232 net groupmap modify ntgroup="Domain Guests" unixgroup=nobody
233 net groupmap modify ntgroup="Administrators" unixgroup=root
234 net groupmap modify ntgroup="Users" unixgroup=users
235 net groupmap modify ntgroup="Guests" unixgroup=nobody
236 net groupmap modify ntgroup="System Operators" unixgroup=sys
237 net groupmap modify ntgroup="Account Operators" unixgroup=root
238 net groupmap modify ntgroup="Backup Operators" unixgroup=bin
239 net groupmap modify ntgroup="Print Operators" unixgroup=lp
240 net groupmap modify ntgroup="Replicators" unixgroup=daemon
241 net groupmap modify ntgroup="Power Users" unixgroup=sys
242
243 #groupadd Engineers
244 #groupadd Marketoids
245 #groupadd Gnomes
246
247 #net groupmap add ntgroup="Engineers"  unixgroup=Engineers    type=d
248 #net groupmap add ntgroup="Marketoids" unixgroup=Marketoids   type=d
249 #net groupmap add ntgroup="Gnomes"     unixgroup=Gnomes       type=d
250 </screen>
251 </para>
252
253         <para>
254         Of course it is expected that the admininstrator will modify this to suit local needs.
255         For information regarding the use of the <command>net groupmap</command> tool please
256         refer to the man page.
257         </para>
258
259         </sect2>
260
261 </sect1>
262
263 <sect1>
264 <title>Common Errors</title>
265
266 <para>
267 At this time there are many little surprises for the unwary administrator. In a real sense
268 it is imperative that every step of automated control scripts must be carefully tested
269 manually before putting them into active service.
270 </para>
271
272         <sect2>
273         <title>Adding Groups Fails</title>
274
275                 <para>
276                 This is a common problem when the <command>groupadd</command> is called directly
277                 by the samba interface script for the <parameter>add group script</parameter> in
278                 the &smb.conf; file.
279                 </para>
280
281                 <para>
282                 The most common cause of failure is an attempt to add an MS Windows group acocunt
283                 that has either an upper case character and/or a space character in it.
284                 </para>
285
286                 <para>
287                 There are three possible work-arounds. Firstly, use only group names that comply
288                 with the limitations of the Unix/Linux <command>groupadd</command> system tool.
289                 The second involves use of the script mentioned earlier in this chapter, and the
290                 third option is to manually create a Unix/Linux group account that can substitute
291                 for the MS Windows group name, then use the procedure listed above to map that group
292                 to the MS Windows group.
293                 </para>
294
295         </sect2>
296
297         <sect2>
298         <title>Adding MS Windows Groups to MS Windows Groups Fails</title>
299
300                 <para>
301                 Samba-3 does NOT support nexted groups from the MS Windows control environment.
302                 </para>
303
304         </sect2>
305
306 </sect1>
307
308 </chapter>