source3/groupdb/mapping_ldb.c

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *
   4  *  group mapping code on top of ldb
   5  *
   6  *  Copyright (C) Andrew Tridgell              2006
   7  *
   8  * based on tdb group mapping code from groupdb/mapping.c
   9  *
  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 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  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.
  19  *
  20  *  You should have received a copy of the GNU General Public License
  21  *  along with this program; if not, write to the Free Software
  22  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  */
  24
  25 #include "includes.h"
  26 #include "groupdb/mapping.h"
  27 #include "lib/ldb/include/includes.h"
  28 #include "lib/ldb/include/ldb_errors.h"
  29
  30 static struct ldb_context *ldb;
  31
  32 static BOOL mapping_upgrade(const char *tdb_path);
  33
  34 /*
  35   connect to the group mapping ldb
  36 */
  37  BOOL init_group_mapping(void)
  38 {
  39         BOOL existed;
  40         const char *init_ldif[] =
  41                 { "dn: @ATTRIBUTES\n" \
  42                   "ntName: CASE_INSENSITIVE\n" \
  43                   "\n",
  44                   "dn: @INDEXLIST\n" \
  45                   "@IDXATTR: gidNumber\n" \
  46                   "@IDXATTR: ntName\n" \
  47                   "@IDXATTR: memberOf\n" };
  48         const char *db_path, *tdb_path;
  49         int ret;
  50         int flags = 0;
  51
  52         if (ldb != NULL) {
  53                 return True;
  54         }
  55
  56         /* this is needed as Samba3 doesn't have this globally yet */
  57         ldb_global_init();
  58
  59         db_path = lock_path("group_mapping.ldb");
  60
  61         ldb = ldb_init(NULL);
  62         if (ldb == NULL) goto failed;
  63
  64         existed = file_exist(db_path, NULL);
  65
  66         if (lp_parm_bool(-1, "groupmap", "nosync", False)) {
  67                 flags |= LDB_FLG_NOSYNC;
  68         }
  69
  70         ret = ldb_connect(ldb, db_path, flags, NULL);
  71         if (ret != LDB_SUCCESS) {
  72                 goto failed;
  73         }
  74
  75         if (!existed) {
  76                 /* initialise the ldb with an index */
  77                 struct ldb_ldif *ldif;
  78                 int i;
  79                 for (i=0;i<ARRAY_SIZE(init_ldif);i++) {
  80                         ldif = ldb_ldif_read_string(ldb, &init_ldif[i]);
  81                         if (ldif == NULL) goto failed;
  82                         ret = ldb_add(ldb, ldif->msg);
  83                         talloc_free(ldif);
  84                         if (ret == -1) goto failed;
  85                 }
  86         }
  87
  88         /* possibly upgrade */
  89         tdb_path = lock_path("group_mapping.tdb");
  90         if (file_exist(tdb_path, NULL) && !mapping_upgrade(tdb_path)) {
  91                 unlink(lock_path("group_mapping.ldb"));
  92                 goto failed;
  93         }
  94
  95         return True;
  96
  97 failed:
  98         DEBUG(0,("Failed to open group mapping ldb '%s' - '%s'\n",
  99                  db_path, ldb?ldb_errstring(ldb):strerror(errno)));
 100         talloc_free(ldb);
 101         ldb = NULL;
 102         return False;
 103 }
 104
 105
 106 /*
 107   form the DN for a mapping entry from a SID
 108  */
 109 static struct ldb_dn *mapping_dn(TALLOC_CTX *mem_ctx, const DOM_SID *sid)
 110 {
 111         fstring string_sid;
 112         uint32_t rid;
 113         DOM_SID domsid;
 114
 115         sid_copy(&domsid, sid);
 116         if (!sid_split_rid(&domsid, &rid)) {
 117                 return NULL;
 118         }
 119         if (!sid_to_string(string_sid, &domsid)) {
 120                 return NULL;
 121         }
 122         /* we split by domain and rid so we can do a subtree search
 123            when we only want one domain */
 124         return ldb_dn_string_compose(mem_ctx, NULL, "domain=%s,rid=%u",
 125                                      string_sid, rid);
 126 }
 127
 128 /*
 129   add a group mapping entry
 130  */
 131  BOOL add_mapping_entry(GROUP_MAP *map, int flag)
 132 {
 133         struct ldb_message *msg;
 134         int ret, i;
 135         fstring string_sid;
 136
 137         if (!init_group_mapping()) {
 138                 return False;
 139         }
 140
 141         msg = ldb_msg_new(ldb);
 142         if (msg == NULL) return False;
 143
 144         msg->dn = mapping_dn(msg, &map->sid);
 145         if (msg->dn == NULL) goto failed;
 146
 147         if (ldb_msg_add_string(msg, "objectClass", "groupMap") != LDB_SUCCESS ||
 148             ldb_msg_add_string(msg, "sid",
 149                                sid_to_string(string_sid, &map->sid)) != LDB_SUCCESS ||
 150             ldb_msg_add_fmt(msg, "gidNumber", "%u", (unsigned)map->gid) != LDB_SUCCESS ||
 151             ldb_msg_add_fmt(msg, "sidNameUse", "%u", (unsigned)map->sid_name_use) != LDB_SUCCESS ||
 152             ldb_msg_add_string(msg, "ntName", map->nt_name) != LDB_SUCCESS) {
 153                 goto failed;
 154         }
 155
 156         if ((map->comment[0] != '\0') &&
 157             (ldb_msg_add_string(msg, "ntName", map->nt_name) != LDB_SUCCESS)) {
 158                 goto failed;
 159         }
 160
 161         ret = ldb_add(ldb, msg);
 162
 163         /* if it exists we update it. This is a hangover from the semantics the
 164            tdb backend had */
 165         if (ret == LDB_ERR_ENTRY_ALREADY_EXISTS) {
 166                 for (i=0;i<msg->num_elements;i++) {
 167                         msg->elements[i].flags = LDB_FLAG_MOD_REPLACE;
 168                 }
 169                 ret = ldb_modify(ldb, msg);
 170         }
 171
 172         talloc_free(msg);
 173
 174         return ret == LDB_SUCCESS;
 175
 176 failed:
 177         talloc_free(msg);
 178         return False;
 179 }
 180
 181 /*
 182   unpack a ldb message into a GROUP_MAP structure
 183 */
 184 static BOOL msg_to_group_map(struct ldb_message *msg, GROUP_MAP *map)
 185 {
 186         const char *sidstr;
 187
 188         map->gid          = ldb_msg_find_attr_as_int(msg, "gidNumber", -1);
 189         map->sid_name_use = ldb_msg_find_attr_as_int(msg, "sidNameUse", -1);
 190         fstrcpy(map->nt_name, ldb_msg_find_attr_as_string(msg, "ntName", NULL));
 191         fstrcpy(map->comment, ldb_msg_find_attr_as_string(msg, "comment", NULL));
 192         sidstr = ldb_msg_find_attr_as_string(msg, "sid", NULL);
 193
 194         if (!string_to_sid(&map->sid, sidstr) ||
 195             map->gid == (gid_t)-1 ||
 196             map->sid_name_use == (enum lsa_SidType)-1) {
 197                 DEBUG(0,("Unable to unpack group mapping\n"));
 198                 return False;
 199         }
 200
 201         return True;
 202 }
 203
 204 /*
 205  return a group map entry for a given sid
 206 */
 207  BOOL get_group_map_from_sid(DOM_SID sid, GROUP_MAP *map)
 208 {
 209         int ret;
 210         struct ldb_dn *dn;
 211         struct ldb_result *res=NULL;
 212
 213         if (!init_group_mapping()) {
 214                 return False;
 215         }
 216
 217         dn = mapping_dn(ldb, &sid);
 218         if (dn == NULL) goto failed;
 219
 220         ret = ldb_search(ldb, dn, LDB_SCOPE_BASE, NULL, NULL, &res);
 221         talloc_steal(dn, res);
 222         if (ret != LDB_SUCCESS || res->count != 1) {
 223                 goto failed;
 224         }
 225
 226         if (!msg_to_group_map(res->msgs[0], map)) goto failed;
 227
 228         talloc_free(dn);
 229         return True;
 230
 231 failed:
 232         talloc_free(dn);
 233         return False;
 234 }
 235
 236 /*
 237  return a group map entry for a given gid
 238 */
 239  BOOL get_group_map_from_gid(gid_t gid, GROUP_MAP *map)
 240 {
 241         int ret;
 242         char *expr;
 243         struct ldb_result *res=NULL;
 244
 245         if (!init_group_mapping()) {
 246                 return False;
 247         }
 248
 249         expr = talloc_asprintf(ldb, "(&(gidNumber=%u)(objectClass=groupMap))",
 250                                (unsigned)gid);
 251         if (expr == NULL) goto failed;
 252
 253         ret = ldb_search(ldb, NULL, LDB_SCOPE_SUBTREE, expr, NULL, &res);
 254         talloc_steal(expr, res);
 255         if (ret != LDB_SUCCESS || res->count != 1) goto failed;
 256
 257         if (!msg_to_group_map(res->msgs[0], map)) goto failed;
 258
 259         talloc_free(expr);
 260         return True;
 261
 262 failed:
 263         talloc_free(expr);
 264         return False;
 265 }
 266
 267 /*
 268   Return the sid and the type of the unix group.
 269 */
 270  BOOL get_group_map_from_ntname(const char *name, GROUP_MAP *map)
 271 {
 272         int ret;
 273         char *expr;
 274         struct ldb_result *res=NULL;
 275
 276         if (!init_group_mapping()) {
 277                 return False;
 278         }
 279
 280         expr = talloc_asprintf(ldb, "(&(ntName=%s)(objectClass=groupMap))", name);
 281         if (expr == NULL) goto failed;
 282
 283         ret = ldb_search(ldb, NULL, LDB_SCOPE_SUBTREE, expr, NULL, &res);
 284         talloc_steal(expr, res);
 285         if (ret != LDB_SUCCESS || res->count != 1) goto failed;
 286
 287         if (!msg_to_group_map(res->msgs[0], map)) goto failed;
 288
 289         talloc_free(expr);
 290         return True;
 291
 292 failed:
 293         talloc_free(expr);
 294         return False;
 295 }
 296
 297 /*
 298  Remove a group mapping entry.
 299 */
 300  BOOL group_map_remove(const DOM_SID *sid)
 301 {
 302         struct ldb_dn *dn;
 303         int ret;
 304
 305         if (!init_group_mapping()) {
 306                 return False;
 307         }
 308
 309         dn = mapping_dn(ldb, sid);
 310         ret = ldb_delete(ldb, dn);
 311         talloc_free(dn);
 312
 313         return ret == LDB_SUCCESS;
 314 }
 315
 316
 317 /*
 318   Enumerate the group mappings for a domain
 319 */
 320  BOOL enum_group_mapping(const DOM_SID *domsid, enum lsa_SidType sid_name_use,
 321                          GROUP_MAP **pp_rmap,
 322                          size_t *p_num_entries, BOOL unix_only)
 323 {
 324         int i, ret;
 325         char *expr;
 326         fstring name;
 327         struct ldb_result *res;
 328         struct ldb_dn *basedn=NULL;
 329         TALLOC_CTX *tmp_ctx;
 330
 331         if (!init_group_mapping()) {
 332                 return False;
 333         }
 334
 335         tmp_ctx = talloc_new(ldb);
 336         if (tmp_ctx == NULL) goto failed;
 337
 338         if (sid_name_use == SID_NAME_UNKNOWN) {
 339                 expr = talloc_asprintf(tmp_ctx, "(&(objectClass=groupMap))");
 340         } else {
 341                 expr = talloc_asprintf(tmp_ctx, "(&(sidNameUse=%u)(objectClass=groupMap))",
 342                                        sid_name_use);
 343         }
 344         if (expr == NULL) goto failed;
 345
 346         /* we do a subtree search on the domain */
 347         if (domsid != NULL) {
 348                 sid_to_string(name, domsid);
 349                 basedn = ldb_dn_string_compose(tmp_ctx, NULL, "domain=%s", name);
 350                 if (basedn == NULL) goto failed;
 351         }
 352
 353         ret = ldb_search(ldb, basedn, LDB_SCOPE_SUBTREE, expr, NULL, &res);
 354         if (ret != LDB_SUCCESS) goto failed;
 355
 356         (*pp_rmap) = NULL;
 357         *p_num_entries = 0;
 358
 359         for (i=0;i<res->count;i++) {
 360                 (*pp_rmap) = SMB_REALLOC_ARRAY((*pp_rmap), GROUP_MAP,
 361                                                (*p_num_entries)+1);
 362                 if (!(*pp_rmap)) goto failed;
 363
 364                 if (!msg_to_group_map(res->msgs[i], &(*pp_rmap)[*p_num_entries])) {
 365                         goto failed;
 366                 }
 367
 368                 (*p_num_entries)++;
 369         }
 370
 371         talloc_free(tmp_ctx);
 372         return True;
 373
 374 failed:
 375         talloc_free(tmp_ctx);
 376         return False;
 377 }
 378
 379 /*
 380    This operation happens on session setup, so it should better be fast. We
 381    store a list of aliases a SID is member of hanging off MEMBEROF/SID.
 382 */
 383  NTSTATUS one_alias_membership(const DOM_SID *member,
 384                                DOM_SID **sids, size_t *num)
 385 {
 386         const char *attrs[] = {
 387                 "sid",
 388                 NULL
 389         };
 390         DOM_SID alias;
 391         char *expr;
 392         int ret, i;
 393         struct ldb_result *res=NULL;
 394         fstring string_sid;
 395         NTSTATUS status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 396
 397         if (!init_group_mapping()) {
 398                 return NT_STATUS_ACCESS_DENIED;
 399         }
 400
 401         *sids = NULL;
 402         *num = 0;
 403
 404         if (!sid_to_string(string_sid, member)) {
 405                 return NT_STATUS_INVALID_PARAMETER;
 406         }
 407
 408         expr = talloc_asprintf(ldb, "(&(memberOf=%s)(objectClass=groupMap))",
 409                                string_sid);
 410         if (expr == NULL) goto failed;
 411
 412         ret = ldb_search(ldb, NULL, LDB_SCOPE_SUBTREE, expr, attrs, &res);
 413         talloc_steal(expr, res);
 414         if (ret != LDB_SUCCESS) {
 415                 goto failed;
 416         }
 417
 418         for (i=0;i<res->count;i++) {
 419                 struct ldb_message_element *el;
 420                 el = ldb_msg_find_element(res->msgs[i], "sid");
 421                 if (el == NULL || el->num_values != 1) {
 422                         status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 423                         goto failed;
 424                 }
 425                 string_to_sid(&alias, (char *)el->values[0].data);
 426                 add_sid_to_array_unique(NULL, &alias, sids, num);
 427                 if (sids == NULL) {
 428                         status = NT_STATUS_NO_MEMORY;
 429                         goto failed;
 430                 }
 431         }
 432
 433         talloc_free(expr);
 434         return NT_STATUS_OK;
 435
 436 failed:
 437         talloc_free(expr);
 438         return status;
 439 }
 440
 441 /*
 442   add/remove a memberOf field
 443 */
 444 static NTSTATUS modify_aliasmem(const DOM_SID *alias, const DOM_SID *member,
 445                                 int operation)
 446 {
 447         fstring string_sid;
 448         int ret;
 449         struct ldb_message msg;
 450         struct ldb_message_element el;
 451         struct ldb_val val;
 452         TALLOC_CTX *tmp_ctx;
 453         GROUP_MAP map;
 454
 455         if (!init_group_mapping()) {
 456                 return NT_STATUS_ACCESS_DENIED;
 457         }
 458
 459         if (!get_group_map_from_sid(*alias, &map)) {
 460                 sid_to_string(string_sid, alias);
 461                 return NT_STATUS_NO_SUCH_ALIAS;
 462         }
 463
 464         if ((map.sid_name_use != SID_NAME_ALIAS) &&
 465             (map.sid_name_use != SID_NAME_WKN_GRP)) {
 466                 DEBUG(0,("sid_name_use=%d\n", map.sid_name_use));
 467                 return NT_STATUS_NO_SUCH_ALIAS;
 468         }
 469
 470         tmp_ctx = talloc_new(NULL);
 471         if (tmp_ctx == NULL) {
 472                 return NT_STATUS_NO_MEMORY;
 473         }
 474
 475         msg.dn = mapping_dn(tmp_ctx, alias);
 476         msg.num_elements = 1;
 477         msg.elements = &el;
 478         el.flags = operation;
 479         el.name = talloc_strdup(tmp_ctx, "memberOf");
 480         el.num_values = 1;
 481         el.values = &val;
 482         sid_to_string(string_sid, member);
 483         val.data = (uint8_t *)string_sid;
 484         val.length = strlen(string_sid);
 485
 486         ret = ldb_modify(ldb, &msg);
 487         talloc_free(tmp_ctx);
 488
 489         if (ret == LDB_ERR_NO_SUCH_OBJECT) {
 490                 return NT_STATUS_NO_SUCH_ALIAS;
 491         }
 492
 493         if (operation == LDB_FLAG_MOD_ADD &&
 494             ret == LDB_ERR_ATTRIBUTE_OR_VALUE_EXISTS) {
 495                 return NT_STATUS_MEMBER_IN_ALIAS;
 496         }
 497
 498         return (ret == LDB_SUCCESS ? NT_STATUS_OK : NT_STATUS_ACCESS_DENIED);
 499 }
 500
 501  NTSTATUS add_aliasmem(const DOM_SID *alias, const DOM_SID *member)
 502 {
 503         return modify_aliasmem(alias, member, LDB_FLAG_MOD_ADD);
 504 }
 505
 506  NTSTATUS del_aliasmem(const DOM_SID *alias, const DOM_SID *member)
 507 {
 508         return modify_aliasmem(alias, member, LDB_FLAG_MOD_DELETE);
 509 }
 510
 511
 512 /*
 513   enumerate sids that have the given alias set in memberOf
 514 */
 515  NTSTATUS enum_aliasmem(const DOM_SID *alias, DOM_SID **sids, size_t *num)
 516 {
 517         const char *attrs[] = {
 518                 "memberOf",
 519                 NULL
 520         };
 521         int ret, i;
 522         struct ldb_result *res=NULL;
 523         struct ldb_dn *dn;
 524         struct ldb_message_element *el;
 525
 526         if (!init_group_mapping()) {
 527                 return NT_STATUS_ACCESS_DENIED;
 528         }
 529
 530         *sids = NULL;
 531         *num = 0;
 532
 533         dn = mapping_dn(ldb, alias);
 534
 535         ret = ldb_search(ldb, dn, LDB_SCOPE_BASE, NULL, attrs, &res);
 536         talloc_steal(dn, res);
 537         if (ret == LDB_SUCCESS && res->count == 0) {
 538                 talloc_free(dn);
 539                 return NT_STATUS_OK;
 540         }
 541         if (ret != LDB_SUCCESS) {
 542                 talloc_free(dn);
 543                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 544         }
 545
 546         el = ldb_msg_find_element(res->msgs[0], "memberOf");
 547         if (el == NULL) {
 548                 talloc_free(dn);
 549                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 550         }
 551
 552         for (i=0;i<el->num_values;i++) {
 553                 DOM_SID sid;
 554                 string_to_sid(&sid, (const char *)el->values[i].data);
 555                 add_sid_to_array_unique(NULL, &sid, sids, num);
 556                 if (sids == NULL) {
 557                         talloc_free(dn);
 558                         return NT_STATUS_NO_MEMORY;
 559                 }
 560         }
 561         talloc_free(dn);
 562
 563         return NT_STATUS_OK;
 564 }
 565
 566 /*
 567   upgrade one group mapping record from the old tdb format
 568 */
 569 static int upgrade_map_record(TDB_CONTEXT *tdb_ctx, TDB_DATA key,
 570                               TDB_DATA data, void *state)
 571 {
 572         int ret;
 573         GROUP_MAP map;
 574
 575         if (strncmp(key.dptr, GROUP_PREFIX,
 576                     MIN(key.dsize, strlen(GROUP_PREFIX))) != 0) {
 577                 return 0;
 578         }
 579
 580         if (!string_to_sid(&map.sid, strlen(GROUP_PREFIX) + (const char *)key.dptr)) {
 581                 DEBUG(0,("Bad sid key '%s' during upgrade\n", (const char *)key.dptr));
 582                 *(int *)state = -1;
 583                 return -1;
 584         }
 585
 586         ret = tdb_unpack(data.dptr, data.dsize, "ddff",
 587                          &map.gid, &map.sid_name_use, &map.nt_name, &map.comment);
 588         if (ret == -1) {
 589                 DEBUG(0,("Failed to unpack group map record during upgrade\n"));
 590                 *(int *)state = -1;
 591                 return -1;
 592         }
 593
 594         if (!add_mapping_entry(&map, 0)) {
 595                 DEBUG(0,("Failed to add mapping entry during upgrade\n"));
 596                 *(int *)state = -1;
 597                 return -1;
 598         }
 599
 600         return 0;
 601 }
 602
 603 /*
 604   upgrade one alias record from the old tdb format
 605 */
 606 static int upgrade_alias_record(TDB_CONTEXT *tdb_ctx, TDB_DATA key,
 607                                 TDB_DATA data, void *state)
 608 {
 609         const char *p = data.dptr;
 610         fstring string_sid;
 611         DOM_SID member;
 612
 613         if (strncmp(key.dptr, MEMBEROF_PREFIX,
 614                     MIN(key.dsize, strlen(MEMBEROF_PREFIX))) != 0) {
 615                 return 0;
 616         }
 617
 618         if (!string_to_sid(&member, strlen(MEMBEROF_PREFIX) + (const char *)key.dptr)) {
 619                 DEBUG(0,("Bad alias key %s during upgrade\n",
 620                          (const char *)key.dptr));
 621                 *(int *)state = -1;
 622         }
 623
 624         while (next_token(&p, string_sid, " ", sizeof(string_sid))) {
 625                 DOM_SID alias;
 626                 NTSTATUS status;
 627                 string_to_sid(&alias, string_sid);
 628                 status = add_aliasmem(&alias, &member);
 629                 if (NT_STATUS_EQUAL(status, NT_STATUS_NO_SUCH_ALIAS)) {
 630                         DEBUG(0,("Ignoring orphaned alias record '%s'\n",
 631                                  string_sid));
 632                 } else if (!NT_STATUS_IS_OK(status)) {
 633                         DEBUG(0,("Failed to add alias member during upgrade - %s\n",
 634                                  nt_errstr(status)));
 635                         *(int *)state = -1;
 636                         return -1;
 637                 }
 638         }
 639
 640         return 0;
 641 }
 642
 643 /*
 644   upgrade from a old style tdb
 645 */
 646 static BOOL mapping_upgrade(const char *tdb_path)
 647 {
 648         static TDB_CONTEXT *tdb;
 649         int ret, status=0;
 650         pstring old_path;
 651         pstring new_path;
 652
 653         tdb = tdb_open_log(tdb_path, 0, TDB_DEFAULT, O_RDWR, 0600);
 654         if (tdb == NULL) goto failed;
 655
 656         /* we have to do the map records first, as alias records may
 657            reference them */
 658         ret = tdb_traverse(tdb, upgrade_map_record, &status);
 659         if (ret == -1 || status == -1) goto failed;
 660
 661         ret = tdb_traverse(tdb, upgrade_alias_record, &status);
 662         if (ret == -1 || status == -1) goto failed;
 663
 664         if (tdb) tdb_close(tdb);
 665
 666         pstrcpy(old_path, tdb_path);
 667         pstrcpy(new_path, lock_path("group_mapping.tdb.upgraded"));
 668
 669         if (rename(old_path, new_path) != 0) {
 670                 DEBUG(0,("Failed to rename old group mapping database\n"));
 671                 goto failed;
 672         }
 673         return True;
 674
 675 failed:
 676         DEBUG(0,("Failed to upgrade group mapping database\n"));
 677         if (tdb) tdb_close(tdb);
 678         return False;
 679 }