2 * Unix SMB/CIFS implementation.
4 * group mapping code on top of ldb
6 * Copyright (C) Andrew Tridgell 2006
8 * based on tdb group mapping code from groupdb/mapping.c
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, see <http://www.gnu.org/licenses/>.
25 #include "groupdb/mapping.h"
26 #include "lib/ldb/include/includes.h"
27 #include "lib/ldb/include/ldb_errors.h"
29 static struct ldb_context *ldb;
31 static bool mapping_upgrade(const char *tdb_path);
34 connect to the group mapping ldb
36 static bool init_group_mapping(void)
39 const char *init_ldif[] =
40 { "dn: @ATTRIBUTES\n" \
41 "ntName: CASE_INSENSITIVE\n" \
44 "@IDXATTR: gidNumber\n" \
45 "@IDXATTR: ntName\n" \
46 "@IDXATTR: member\n" };
47 const char *db_path, *tdb_path;
55 /* this is needed as Samba3 doesn't have this globally yet */
58 db_path = state_path("group_mapping.ldb");
61 if (ldb == NULL) goto failed;
63 existed = file_exist(db_path, NULL);
65 if (lp_parm_bool(-1, "groupmap", "nosync", False)) {
66 flags |= LDB_FLG_NOSYNC;
70 flags |= LDB_FLG_NOMMAP;
73 ret = ldb_connect(ldb, db_path, flags, NULL);
74 if (ret != LDB_SUCCESS) {
79 /* initialise the ldb with an index */
80 struct ldb_ldif *ldif;
82 for (i=0;i<ARRAY_SIZE(init_ldif);i++) {
83 ldif = ldb_ldif_read_string(ldb, &init_ldif[i]);
84 if (ldif == NULL) goto failed;
85 ret = ldb_add(ldb, ldif->msg);
87 if (ret == -1) goto failed;
91 /* possibly upgrade */
92 tdb_path = state_path("group_mapping.tdb");
93 if (file_exist(tdb_path, NULL) && !mapping_upgrade(tdb_path)) {
94 unlink(state_path("group_mapping.ldb"));
101 DEBUG(0,("Failed to open group mapping ldb '%s' - '%s'\n",
102 db_path, ldb?ldb_errstring(ldb):strerror(errno)));
110 form the DN for a mapping entry from a SID
112 static struct ldb_dn *mapping_dn(TALLOC_CTX *mem_ctx, const DOM_SID *sid)
118 sid_copy(&domsid, sid);
119 if (!sid_split_rid(&domsid, &rid)) {
122 if (!sid_to_fstring(string_sid, &domsid)) {
125 /* we split by domain and rid so we can do a subtree search
126 when we only want one domain */
127 return ldb_dn_string_compose(mem_ctx, NULL, "rid=%u,domain=%s",
132 add a group mapping entry
134 static bool add_mapping_entry(GROUP_MAP *map, int flag)
136 struct ldb_message *msg;
140 msg = ldb_msg_new(ldb);
145 msg->dn = mapping_dn(msg, &map->sid);
146 if (msg->dn == NULL) {
150 if (ldb_msg_add_string(msg, "objectClass", "groupMap") != LDB_SUCCESS ||
151 ldb_msg_add_string(msg, "sid",
152 sid_to_fstring(string_sid, &map->sid)) != LDB_SUCCESS ||
153 ldb_msg_add_fmt(msg, "gidNumber", "%u", (unsigned)map->gid) != LDB_SUCCESS ||
154 ldb_msg_add_fmt(msg, "sidNameUse", "%u", (unsigned)map->sid_name_use) != LDB_SUCCESS ||
155 ldb_msg_add_string(msg, "comment", map->comment) != LDB_SUCCESS ||
156 ldb_msg_add_string(msg, "ntName", map->nt_name) != LDB_SUCCESS) {
160 ret = ldb_add(ldb, msg);
162 /* if it exists we update it. This is a hangover from the semantics the
164 if (ret == LDB_ERR_ENTRY_ALREADY_EXISTS) {
165 for (i=0;i<msg->num_elements;i++) {
166 msg->elements[i].flags = LDB_FLAG_MOD_REPLACE;
168 ret = ldb_modify(ldb, msg);
173 return ret == LDB_SUCCESS;
181 unpack a ldb message into a GROUP_MAP structure
183 static bool msg_to_group_map(struct ldb_message *msg, GROUP_MAP *map)
187 map->gid = ldb_msg_find_attr_as_int(msg, "gidNumber", -1);
188 map->sid_name_use = ldb_msg_find_attr_as_int(msg, "sidNameUse", -1);
189 fstrcpy(map->nt_name, ldb_msg_find_attr_as_string(msg, "ntName", NULL));
190 fstrcpy(map->comment, ldb_msg_find_attr_as_string(msg, "comment", NULL));
191 sidstr = ldb_msg_find_attr_as_string(msg, "sid", NULL);
193 if (!string_to_sid(&map->sid, sidstr) ||
194 map->gid == (gid_t)-1 ||
195 map->sid_name_use == (enum lsa_SidType)-1) {
196 DEBUG(0,("Unable to unpack group mapping\n"));
204 return a group map entry for a given sid
206 static bool get_group_map_from_sid(DOM_SID sid, GROUP_MAP *map)
210 struct ldb_result *res=NULL;
212 dn = mapping_dn(ldb, &sid);
213 if (dn == NULL) goto failed;
215 ret = ldb_search(ldb, dn, LDB_SCOPE_BASE, NULL, NULL, &res);
216 talloc_steal(dn, res);
217 if (ret != LDB_SUCCESS || res->count != 1) {
221 if (!msg_to_group_map(res->msgs[0], map)) goto failed;
232 return a group map entry for a given gid
234 static bool get_group_map_from_gid(gid_t gid, GROUP_MAP *map)
238 struct ldb_result *res=NULL;
240 expr = talloc_asprintf(ldb, "(&(gidNumber=%u)(objectClass=groupMap))",
242 if (expr == NULL) goto failed;
244 ret = ldb_search(ldb, NULL, LDB_SCOPE_SUBTREE, expr, NULL, &res);
245 talloc_steal(expr, res);
246 if (ret != LDB_SUCCESS || res->count != 1) goto failed;
248 if (!msg_to_group_map(res->msgs[0], map)) goto failed;
259 Return the sid and the type of the unix group.
261 static bool get_group_map_from_ntname(const char *name, GROUP_MAP *map)
265 struct ldb_result *res=NULL;
267 expr = talloc_asprintf(ldb, "(&(ntName=%s)(objectClass=groupMap))", name);
268 if (expr == NULL) goto failed;
270 ret = ldb_search(ldb, NULL, LDB_SCOPE_SUBTREE, expr, NULL, &res);
271 talloc_steal(expr, res);
272 if (ret != LDB_SUCCESS || res->count != 1) goto failed;
274 if (!msg_to_group_map(res->msgs[0], map)) goto failed;
285 Remove a group mapping entry.
287 static bool group_map_remove(const DOM_SID *sid)
292 dn = mapping_dn(ldb, sid);
296 ret = ldb_delete(ldb, dn);
299 return ret == LDB_SUCCESS;
304 Enumerate the group mappings for a domain
306 static bool enum_group_mapping(const DOM_SID *domsid, enum lsa_SidType sid_name_use,
308 size_t *p_num_entries, bool unix_only)
313 struct ldb_result *res = NULL;
314 struct ldb_dn *basedn=NULL;
317 tmp_ctx = talloc_new(ldb);
318 if (tmp_ctx == NULL) goto failed;
320 if (sid_name_use == SID_NAME_UNKNOWN) {
321 expr = talloc_asprintf(tmp_ctx, "(&(objectClass=groupMap))");
323 expr = talloc_asprintf(tmp_ctx, "(&(sidNameUse=%u)(objectClass=groupMap))",
326 if (expr == NULL) goto failed;
328 /* we do a subtree search on the domain */
329 if (domsid != NULL) {
330 sid_to_fstring(name, domsid);
331 basedn = ldb_dn_string_compose(tmp_ctx, NULL, "domain=%s", name);
332 if (basedn == NULL) goto failed;
335 ret = ldb_search(ldb, basedn, LDB_SCOPE_SUBTREE, expr, NULL, &res);
336 talloc_steal(tmp_ctx, res);
337 if (ret != LDB_SUCCESS) goto failed;
342 for (i=0;i<res->count;i++) {
343 (*pp_rmap) = SMB_REALLOC_ARRAY((*pp_rmap), GROUP_MAP,
345 if (!(*pp_rmap)) goto failed;
347 if (!msg_to_group_map(res->msgs[i], &(*pp_rmap)[*p_num_entries])) {
354 talloc_free(tmp_ctx);
358 talloc_free(tmp_ctx);
363 This operation happens on session setup, so it should better be fast. We
364 store a list of aliases a SID is member of hanging off MEMBEROF/SID.
366 static NTSTATUS one_alias_membership(const DOM_SID *member,
367 DOM_SID **sids, size_t *num)
369 const char *attrs[] = {
376 struct ldb_result *res=NULL;
378 NTSTATUS status = NT_STATUS_INTERNAL_DB_CORRUPTION;
380 if (!sid_to_fstring(string_sid, member)) {
381 return NT_STATUS_INVALID_PARAMETER;
384 expr = talloc_asprintf(ldb, "(&(member=%s)(objectClass=groupMap))",
386 if (expr == NULL) goto failed;
388 ret = ldb_search(ldb, NULL, LDB_SCOPE_SUBTREE, expr, attrs, &res);
389 talloc_steal(expr, res);
390 if (ret != LDB_SUCCESS) {
394 for (i=0;i<res->count;i++) {
395 struct ldb_message_element *el;
396 el = ldb_msg_find_element(res->msgs[i], "sid");
397 if (el == NULL || el->num_values != 1) {
398 status = NT_STATUS_INTERNAL_DB_CORRUPTION;
401 string_to_sid(&alias, (char *)el->values[0].data);
402 status = add_sid_to_array_unique(NULL, &alias, sids, num);
403 if (!NT_STATUS_IS_OK(status)) {
417 add/remove a member field
419 static NTSTATUS modify_aliasmem(const DOM_SID *alias, const DOM_SID *member,
424 struct ldb_message msg;
425 struct ldb_message_element el;
430 if (!get_group_map_from_sid(*alias, &map)) {
431 sid_to_fstring(string_sid, alias);
432 return NT_STATUS_NO_SUCH_ALIAS;
435 if ((map.sid_name_use != SID_NAME_ALIAS) &&
436 (map.sid_name_use != SID_NAME_WKN_GRP)) {
437 DEBUG(0,("sid_name_use=%d\n", map.sid_name_use));
438 return NT_STATUS_NO_SUCH_ALIAS;
441 tmp_ctx = talloc_new(NULL);
442 if (tmp_ctx == NULL) {
443 return NT_STATUS_NO_MEMORY;
446 msg.dn = mapping_dn(tmp_ctx, alias);
447 if (msg.dn == NULL) {
448 return NT_STATUS_NO_MEMORY;
450 msg.num_elements = 1;
452 el.flags = operation;
453 el.name = talloc_strdup(tmp_ctx, "member");
456 sid_to_fstring(string_sid, member);
457 val.data = (uint8_t *)string_sid;
458 val.length = strlen(string_sid);
460 ret = ldb_modify(ldb, &msg);
461 talloc_free(tmp_ctx);
463 if (ret == LDB_ERR_NO_SUCH_OBJECT) {
464 return NT_STATUS_NO_SUCH_ALIAS;
467 if (operation == LDB_FLAG_MOD_ADD &&
468 ret == LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS) {
469 return NT_STATUS_MEMBER_IN_ALIAS;
472 return (ret == LDB_SUCCESS ? NT_STATUS_OK : NT_STATUS_ACCESS_DENIED);
475 static NTSTATUS add_aliasmem(const DOM_SID *alias, const DOM_SID *member)
477 return modify_aliasmem(alias, member, LDB_FLAG_MOD_ADD);
480 static NTSTATUS del_aliasmem(const DOM_SID *alias, const DOM_SID *member)
482 return modify_aliasmem(alias, member, LDB_FLAG_MOD_DELETE);
487 enumerate sids that have the given alias set in member
489 static NTSTATUS enum_aliasmem(const DOM_SID *alias, DOM_SID **sids, size_t *num)
491 const char *attrs[] = {
496 NTSTATUS status = NT_STATUS_OK;
497 struct ldb_result *res=NULL;
499 struct ldb_message_element *el;
504 dn = mapping_dn(ldb, alias);
506 return NT_STATUS_NO_MEMORY;
509 ret = ldb_search(ldb, dn, LDB_SCOPE_BASE, NULL, attrs, &res);
510 talloc_steal(dn, res);
511 if (ret == LDB_SUCCESS && res->count == 0) {
515 if (ret != LDB_SUCCESS) {
517 return NT_STATUS_INTERNAL_DB_CORRUPTION;
520 el = ldb_msg_find_element(res->msgs[0], "member");
523 return NT_STATUS_INTERNAL_DB_CORRUPTION;
526 for (i=0;i<el->num_values;i++) {
528 string_to_sid(&sid, (const char *)el->values[i].data);
529 status = add_sid_to_array_unique(NULL, &sid, sids, num);
530 if (!NT_STATUS_IS_OK(status)) {
541 upgrade one group mapping record from the old tdb format
543 static int upgrade_map_record(TDB_CONTEXT *tdb_ctx, TDB_DATA key,
544 TDB_DATA data, void *state)
549 if (strncmp((char *)key.dptr, GROUP_PREFIX,
550 MIN(key.dsize, strlen(GROUP_PREFIX))) != 0) {
554 if (!string_to_sid(&map.sid, strlen(GROUP_PREFIX) + (const char *)key.dptr)) {
555 DEBUG(0,("Bad sid key '%s' during upgrade\n", (const char *)key.dptr));
560 ret = tdb_unpack(data.dptr, data.dsize, "ddff",
561 &map.gid, &map.sid_name_use, &map.nt_name, &map.comment);
563 DEBUG(0,("Failed to unpack group map record during upgrade\n"));
568 if (!add_mapping_entry(&map, 0)) {
569 DEBUG(0,("Failed to add mapping entry during upgrade\n"));
578 upgrade one alias record from the old tdb format
580 static int upgrade_alias_record(TDB_CONTEXT *tdb_ctx, TDB_DATA key,
581 TDB_DATA data, void *state)
583 const char *p = (const char *)data.dptr;
588 if (strncmp((char *)key.dptr, MEMBEROF_PREFIX,
589 MIN(key.dsize, strlen(MEMBEROF_PREFIX))) != 0) {
593 if (!string_to_sid(&member, strlen(MEMBEROF_PREFIX) + (const char *)key.dptr)) {
594 DEBUG(0,("Bad alias key %s during upgrade\n",
595 (const char *)key.dptr));
599 frame = talloc_stackframe();
600 while (next_token_talloc(frame,&p, &string_sid, " ")) {
603 string_to_sid(&alias, string_sid);
604 status = add_aliasmem(&alias, &member);
605 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_SUCH_ALIAS)) {
606 DEBUG(0,("Ignoring orphaned alias record '%s'\n",
608 } else if (!NT_STATUS_IS_OK(status)) {
609 DEBUG(0,("Failed to add alias member during upgrade - %s\n",
621 upgrade from a old style tdb
623 static bool mapping_upgrade(const char *tdb_path)
625 static TDB_CONTEXT *tdb;
628 tdb = tdb_open_log(tdb_path, 0, TDB_DEFAULT, O_RDWR, 0600);
629 if (tdb == NULL) goto failed;
631 /* we have to do the map records first, as alias records may
633 ret = tdb_traverse(tdb, upgrade_map_record, &status);
634 if (ret == -1 || status == -1) goto failed;
636 ret = tdb_traverse(tdb, upgrade_alias_record, &status);
637 if (ret == -1 || status == -1) goto failed;
645 const char *old_path = tdb_path;
646 char *new_path = state_path("group_mapping.tdb.upgraded");
651 if (rename(old_path, new_path) != 0) {
652 DEBUG(0,("Failed to rename old group mapping database\n"));
659 DEBUG(0,("Failed to upgrade group mapping database\n"));
660 if (tdb) tdb_close(tdb);
666 static const struct mapping_backend ldb_backend = {
667 .add_mapping_entry = add_mapping_entry,
668 .get_group_map_from_sid = get_group_map_from_sid,
669 .get_group_map_from_gid = get_group_map_from_gid,
670 .get_group_map_from_ntname = get_group_map_from_ntname,
671 .group_map_remove = group_map_remove,
672 .enum_group_mapping = enum_group_mapping,
673 .one_alias_membership = one_alias_membership,
674 .add_aliasmem = add_aliasmem,
675 .del_aliasmem = del_aliasmem,
676 .enum_aliasmem = enum_aliasmem
680 initialise the ldb mapping backend
682 const struct mapping_backend *groupdb_ldb_init(void)
684 if (!init_group_mapping()) {
685 DEBUG(0,("Failed to initialise ldb mapping backend\n"));