summaryrefslogtreecommitdiff
path: root/source3/sam/idmap_util.c
blob: 095f5f0874c4a077ca583b12bdb633788e9b8169 (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
/* 
   Unix SMB/CIFS implementation.
   ID Mapping
   Copyright (C) Simo Sorce 2003

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.*/

#include "includes.h"

#undef DBGC_CLASS
#define DBGC_CLASS DBGC_IDMAP


/******************************************************************
 * Get the free RID base if idmap is configured, otherwise return 0
 ******************************************************************/

uint32 idmap_get_free_rid_base(void)
{
	uint32 low, high;
	if (idmap_get_free_rid_range(&low, &high)) {
		return low;
	}
	return 0;
}

BOOL idmap_check_ugid_is_in_free_range(uint32 id)
{
	uint32 low, high;

	if (!idmap_get_free_ugid_range(&low, &high)) {
		return False;
	}
	if (id < low || id > high) {
		return False;
	}
	return True;
}

BOOL idmap_check_rid_is_in_free_range(uint32 rid)
{
	uint32 low, high;

	if (!idmap_get_free_rid_range(&low, &high)) {
		return False;
	}
	if (rid < low || rid > high) {
		return False;
	}
	return True;
}

/* if it is a foreign SID or if the SID is in the free range, return true */

BOOL idmap_check_sid_is_in_free_range(const DOM_SID *sid)
{
	if (sid_compare_domain(get_global_sam_sid(), sid) == 0) {
	
		uint32 rid;

		if (sid_peek_rid(sid, &rid)) {
			return idmap_check_rid_is_in_free_range(rid);
		}

		return False;
	}

	return True;
}

/******************************************************************
 * Get the the non-algorithmic RID range if idmap range are defined
 ******************************************************************/

BOOL idmap_get_free_rid_range(uint32 *low, uint32 *high)
{
	uint32 id_low, id_high;

	if (lp_idmap_only()) {
		*low = BASE_RID;
		*high = (uint32)-1;
	}

	if (!idmap_get_free_ugid_range(&id_low, &id_high)) {
		return False;
	}

	*low = fallback_pdb_uid_to_user_rid(id_low);
	if (fallback_pdb_user_rid_to_uid((uint32)-1) < id_high) {
		*high = (uint32)-1;
	} else {
		*high = fallback_pdb_uid_to_user_rid(id_high);
	}

	return True;
}

BOOL idmap_get_free_ugid_range(uint32 *low, uint32 *high)
{
	uid_t u_low, u_high;
	gid_t g_low, g_high;

	if (!lp_idmap_uid(&u_low, &u_high) || !lp_idmap_gid(&g_low, &g_high)) {
		return False;
	}
	if (u_low < g_low) {
		*low = u_low;
	} else {
		*low = g_low;
	}
	if (u_high < g_high) {
		*high = g_high;
	} else {
		*high = u_high;
	}
	return True;
}

/*****************************************************************
 *THE CANONICAL* convert uid_t to SID function.
 check idmap if uid is in idmap range, otherwise falls back to
 the legacy algorithmic mapping.
 A special cache is used for uids that maps to Wellknown SIDs
 Returns SID pointer.
*****************************************************************/  

NTSTATUS uid_to_sid(DOM_SID *sid, uid_t uid)
{
	NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
	unid_t id;
	int flags;

	DEBUG(10,("uid_to_sid: uid = [%d]\n", uid));

	flags = ID_USERID;
	if (!lp_idmap_only() && !idmap_check_ugid_is_in_free_range(uid)) {
		flags |= ID_QUERY_ONLY;
	}

	id.uid = uid;
	if (!NT_STATUS_IS_OK(ret = idmap_get_sid_from_id(sid, id, flags))) {
		DEBUG(10, ("uid_to_sid: Failed to map uid = [%u]\n", (unsigned int)uid));
		if (flags & ID_QUERY_ONLY) {
			sid_copy(sid, get_global_sam_sid());
			sid_append_rid(sid, fallback_pdb_uid_to_user_rid(uid));

			DEBUG(10,("uid_to_sid: Fall back to algorithmic mapping: %u -> %s\n", (unsigned int)uid, sid_string_static(sid)));
			ret = NT_STATUS_OK;
		}
	}

	return ret;
}

/*****************************************************************
 *THE CANONICAL* convert gid_t to SID function.
 check idmap if gid is in idmap range, otherwise falls back to
 the legacy algorithmic mapping.
 Group mapping is used for gids that maps to Wellknown SIDs
 Returns SID pointer.
*****************************************************************/  

NTSTATUS gid_to_sid(DOM_SID *sid, gid_t gid)
{
	NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
	unid_t id;
	int flags;

	DEBUG(10,("gid_to_sid: gid = [%d]\n", gid));

	flags = ID_GROUPID;
	if (!lp_idmap_only() && !idmap_check_ugid_is_in_free_range(gid)) {
		flags |= ID_QUERY_ONLY;
	}

	id.gid = gid;
	if (!NT_STATUS_IS_OK(ret = idmap_get_sid_from_id(sid, id, flags))) {
		DEBUG(10, ("gid_to_sid: Failed to map gid = [%u]\n", (unsigned int)gid));
		if (flags & ID_QUERY_ONLY) {
			sid_copy(sid, get_global_sam_sid());
			sid_append_rid(sid, pdb_gid_to_group_rid(gid));

			DEBUG(10,("gid_to_sid: Fall back to algorithmic mapping: %u -> %s\n", (unsigned int)gid, sid_string_static(sid)));
			ret = NT_STATUS_OK;
		}
	}

	return ret;
}

/*****************************************************************
 *THE CANONICAL* convert SID to uid function.
 if it is a foreign sid or it is in idmap rid range check idmap,
 otherwise falls back to the legacy algorithmic mapping.
 A special cache is used for uids that maps to Wellknown SIDs
 Returns True if this name is a user sid and the conversion
 was done correctly, False if not.
*****************************************************************/  

NTSTATUS sid_to_uid(const DOM_SID *sid, uid_t *uid)
{
	NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
	BOOL fallback = False;
	unid_t id;
	int flags;

	DEBUG(10,("sid_to_uid: sid = [%s]\n", sid_string_static(sid)));

	flags = ID_USERID;
	if (!lp_idmap_only()) {
		if (!idmap_check_sid_is_in_free_range(sid)) {
			flags |= ID_QUERY_ONLY;
			fallback = True;
		}
	}

	if (NT_STATUS_IS_OK(ret = idmap_get_id_from_sid(&id, &flags, sid))) {

		DEBUG(10,("sid_to_uid: uid = [%d]\n", id.uid));

		*uid = id.uid;
		
	} else if (fallback) {
		uint32 rid;

		if (!sid_peek_rid(sid, &rid)) {
			DEBUG(10,("sid_to_uid: invalid SID!\n"));
			ret = NT_STATUS_INVALID_PARAMETER;
			goto done;
		}

		DEBUG(10,("sid_to_uid: Fall back to algorithmic mapping\n"));

		if (!fallback_pdb_rid_is_user(rid)) {
			DEBUG(3, ("sid_to_uid: SID %s is *NOT* a user\n", sid_string_static(sid)));
			ret = NT_STATUS_UNSUCCESSFUL;
		} else {
			*uid = fallback_pdb_user_rid_to_uid(rid);
			DEBUG(10,("sid_to_uid: mapping: %s -> %u\n", sid_string_static(sid), (unsigned int)(*uid)));
			ret = NT_STATUS_OK;
		}
	}

done:
	return ret;
}

/*****************************************************************
 *THE CANONICAL* convert SID to gid function.
 if it is a foreign sid or it is in idmap rid range check idmap,
 otherwise falls back to the legacy algorithmic mapping.
 Group mapping is used for gids that maps to Wellknown SIDs
 Returns True if this name is a user sid and the conversion
 was done correctly, False if not.
*****************************************************************/  

NTSTATUS sid_to_gid(const DOM_SID *sid, gid_t *gid)
{
	NTSTATUS ret = NT_STATUS_UNSUCCESSFUL;
	BOOL fallback = False;
	unid_t id;
	int flags;

	DEBUG(10,("sid_to_gid: sid = [%s]\n", sid_string_static(sid)));

	flags = ID_GROUPID;
	if (!lp_idmap_only()) {
		if (!idmap_check_sid_is_in_free_range(sid)) {
			flags |= ID_QUERY_ONLY;
			fallback = True;
		}
	}

	if (NT_STATUS_IS_OK(ret = idmap_get_id_from_sid(&id, &flags, sid))) {
		
		DEBUG(10,("sid_to_gid: gid = [%d]\n", id.gid));
		*gid = id.gid;

	} else if (fallback) {
		uint32 rid;

		if (!sid_peek_rid(sid, &rid)) {
			DEBUG(10,("sid_to_uid: invalid SID!\n"));
			return NT_STATUS_INVALID_PARAMETER;
		}

		DEBUG(10,("sid_to_gid: Fall back to algorithmic mapping\n"));

		if (fallback_pdb_rid_is_user(rid)) {
			DEBUG(3, ("sid_to_gid: SID %s is *NOT* a group\n", sid_string_static(sid)));
			ret = NT_STATUS_UNSUCCESSFUL;
		} else {
			*gid = pdb_group_rid_to_gid(rid);
			DEBUG(10,("sid_to_gid: mapping: %s -> %u\n", sid_string_static(sid), (unsigned int)(*gid)));
			ret = NT_STATUS_OK;
		}
	}

	return ret;
}

/***************************************************************************
 Check first, call set_mapping if it doesn't already exist.
***************************************************************************/

static NTSTATUS wellknown_id_init(DOM_SID *sid, unid_t id, int flags)
{
	unid_t storedid;
	int qflags = flags | ID_QUERY_ONLY;

	if (!NT_STATUS_IS_OK(idmap_get_id_from_sid(&storedid, &qflags, sid))) {
		return idmap_set_mapping(sid, id, flags);
	} else {
		if (flags == ID_USERID && id.uid != storedid.uid) {
			DEBUG(0,("wellknown_id_init: WARNING ! Stored uid %u for SID %s is not the same as the requested uid %u\n",
				(unsigned int)storedid.uid, sid_string_static(sid), (unsigned int)id.uid ));
			DEBUG(0,("wellknown_id_init: Attempting to overwrite old mapping with new.\n"));
			return idmap_set_mapping(sid, id, flags);
		} else if (flags == ID_GROUPID && id.gid != storedid.gid) {
			DEBUG(0,("wellknown_id_init: WARNING ! Stored gid %u for SID %s is not the same as the requested gid %u\n",
				(unsigned int)storedid.gid, sid_string_static(sid), (unsigned int)id.gid ));
			DEBUG(0,("wellknown_id_init: Attempting to overwrite old mapping with new.\n"));
			return idmap_set_mapping(sid, id, flags);
		}
	}
	return NT_STATUS_OK;
}

/***************************************************************************
 Initialize idmap withWellknown SIDs like Guest, that are necessary
 to make samba run properly.
***************************************************************************/

BOOL idmap_init_wellknown_sids(void)
{
	const char *guest_account = lp_guestaccount();
	struct passwd *pass;
	GROUP_MAP *map=NULL;
	int num_entries=0;
	DOM_SID sid;
	unid_t id;

	if (!(guest_account && *guest_account)) {
		DEBUG(1, ("NULL guest account!?!?\n"));
		return False;
	}

	pass = getpwnam_alloc(guest_account);
	if (!pass) {
		return False;
	}

	/* Fill in the SID for the guest account. */
	id.uid = pass->pw_uid;
	sid_copy(&sid, get_global_sam_sid());
	sid_append_rid(&sid, DOMAIN_USER_RID_GUEST);

	if (!NT_STATUS_IS_OK(wellknown_id_init(&sid, id, ID_USERID))) {
		passwd_free(&pass);
		return False;
	}

	/* check if DOMAIN_GROUP_RID_GUESTS SID is set, if not store the
	 * guest account gid as mapping */
	id.gid = pass->pw_gid;
	sid_copy(&sid, get_global_sam_sid());
	sid_append_rid(&sid, DOMAIN_GROUP_RID_GUESTS);
	if (!NT_STATUS_IS_OK(wellknown_id_init(&sid, id, ID_GROUPID))) {
		passwd_free(&pass);
		return False;
	}

	passwd_free(&pass);
	/* now fill in group mappings */
	if(pdb_enum_group_mapping(SID_NAME_UNKNOWN, &map, &num_entries, ENUM_ONLY_MAPPED)) {
		int i;

		for (i = 0; i < num_entries; i++) {
			id.gid = map[i].gid;
			wellknown_id_init(&map[i].sid, id, ID_GROUPID);
		}
		SAFE_FREE(map);
	}

	return True;
}