2 Unix SMB/CIFS implementation.
6 Copyright (C) Tim Potter 2000
7 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
8 Copyright (C) Jeremy Allison 2006
9 Copyright (C) Simo Sorce 2003-2006
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #define DBGC_CLASS DBGC_IDMAP
31 /* idmap version determines auto-conversion - this is the database
32 structure version specifier. */
34 #define IDMAP_VERSION 2
36 struct idmap_tdb_context {
37 struct db_context *db;
40 /* High water mark keys */
41 #define HWM_GROUP "GROUP HWM"
42 #define HWM_USER "USER HWM"
44 struct convert_fn_state {
45 struct db_context *db;
49 /*****************************************************************************
50 For idmap conversion: convert one record to new format
51 Ancient versions (eg 2.2.3a) of winbindd_idmap.tdb mapped DOMAINNAME/rid
53 *****************************************************************************/
54 static int convert_fn(struct db_record *rec, void *private_data)
56 struct winbindd_domain *domain;
64 struct convert_fn_state *s = (struct convert_fn_state *)private_data;
66 DEBUG(10,("Converting %s\n", (const char *)rec->key.dptr));
68 p = strchr((const char *)rec->key.dptr, '/');
73 fstrcpy(dom_name, (const char *)rec->key.dptr);
76 domain = find_domain_from_name(dom_name);
78 /* We must delete the old record. */
79 DEBUG(0,("Unable to find domain %s\n", dom_name ));
80 DEBUG(0,("deleting record %s\n", (const char *)rec->key.dptr ));
82 status = rec->delete_rec(rec);
83 if (!NT_STATUS_IS_OK(status)) {
84 DEBUG(0, ("Unable to delete record %s:%s\n",
85 (const char *)rec->key.dptr,
96 sid_copy(&sid, &domain->sid);
97 sid_append_rid(&sid, rid);
99 sid_to_fstring(keystr, &sid);
100 key2 = string_term_tdb_data(keystr);
102 status = dbwrap_store(s->db, key2, rec->value, TDB_INSERT);
103 if (!NT_STATUS_IS_OK(status)) {
104 DEBUG(0,("Unable to add record %s:%s\n",
105 (const char *)key2.dptr,
111 status = dbwrap_store(s->db, rec->value, key2, TDB_REPLACE);
112 if (!NT_STATUS_IS_OK(status)) {
113 DEBUG(0,("Unable to update record %s:%s\n",
114 (const char *)rec->value.dptr,
120 status = rec->delete_rec(rec);
121 if (!NT_STATUS_IS_OK(status)) {
122 DEBUG(0,("Unable to delete record %s:%s\n",
123 (const char *)rec->key.dptr,
132 /*****************************************************************************
133 Convert the idmap database from an older version.
134 *****************************************************************************/
136 static bool idmap_tdb_upgrade(struct idmap_domain *dom, struct db_context *db)
139 bool bigendianheader;
140 struct convert_fn_state s;
142 DEBUG(0, ("Upgrading winbindd_idmap.tdb from an old version\n"));
144 bigendianheader = (db->get_flags(db) & TDB_BIGENDIAN) ? True : False;
146 vers = dbwrap_fetch_int32(db, "IDMAP_VERSION");
148 if (((vers == -1) && bigendianheader) || (IREV(vers) == IDMAP_VERSION)) {
149 /* Arrggghh ! Bytereversed or old big-endian - make order independent ! */
151 * high and low records were created on a
152 * big endian machine and will need byte-reversing.
157 wm = dbwrap_fetch_int32(db, HWM_USER);
165 if (dbwrap_store_int32(db, HWM_USER, wm) == -1) {
166 DEBUG(0, ("Unable to byteswap user hwm in idmap database\n"));
170 wm = dbwrap_fetch_int32(db, HWM_GROUP);
177 if (dbwrap_store_int32(db, HWM_GROUP, wm) == -1) {
178 DEBUG(0, ("Unable to byteswap group hwm in idmap database\n"));
186 /* the old format stored as DOMAIN/rid - now we store the SID direct */
187 db->traverse(db, convert_fn, &s);
190 DEBUG(0, ("Problem during conversion\n"));
194 if (dbwrap_store_int32(db, "IDMAP_VERSION", IDMAP_VERSION) == -1) {
195 DEBUG(0, ("Unable to store idmap version in databse\n"));
202 static NTSTATUS idmap_tdb_init_hwm(struct idmap_domain *dom)
207 bool update_uid = false;
208 bool update_gid = false;
209 struct idmap_tdb_context *ctx;
211 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
213 low_uid = dbwrap_fetch_int32(ctx->db, HWM_USER);
214 if (low_uid == -1 || low_uid < dom->low_id) {
218 low_gid = dbwrap_fetch_int32(ctx->db, HWM_GROUP);
219 if (low_gid == -1 || low_gid < dom->low_id) {
223 if (!update_uid && !update_gid) {
227 if (ctx->db->transaction_start(ctx->db) != 0) {
228 DEBUG(0, ("Unable to start upgrade transaction!\n"));
229 return NT_STATUS_INTERNAL_DB_ERROR;
233 ret = dbwrap_store_int32(ctx->db, HWM_USER, dom->low_id);
235 ctx->db->transaction_cancel(ctx->db);
236 DEBUG(0, ("Unable to initialise user hwm in idmap "
238 return NT_STATUS_INTERNAL_DB_ERROR;
243 ret = dbwrap_store_int32(ctx->db, HWM_GROUP, dom->low_id);
245 ctx->db->transaction_cancel(ctx->db);
246 DEBUG(0, ("Unable to initialise group hwm in idmap "
248 return NT_STATUS_INTERNAL_DB_ERROR;
252 if (ctx->db->transaction_commit(ctx->db) != 0) {
253 DEBUG(0, ("Unable to commit upgrade transaction!\n"));
254 return NT_STATUS_INTERNAL_DB_ERROR;
260 static NTSTATUS idmap_tdb_open_db(struct idmap_domain *dom)
264 char *tdbfile = NULL;
265 struct db_context *db = NULL;
267 bool config_error = false;
268 struct idmap_tdb_context *ctx;
270 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
272 /* use our own context here */
273 mem_ctx = talloc_stackframe();
275 /* use the old database if present */
276 tdbfile = state_path("winbindd_idmap.tdb");
278 DEBUG(0, ("Out of memory!\n"));
279 ret = NT_STATUS_NO_MEMORY;
283 DEBUG(10,("Opening tdbfile %s\n", tdbfile ));
285 /* Open idmap repository */
286 db = db_open(mem_ctx, tdbfile, 0, TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
288 DEBUG(0, ("Unable to open idmap database\n"));
289 ret = NT_STATUS_UNSUCCESSFUL;
293 /* check against earlier versions */
294 version = dbwrap_fetch_int32(db, "IDMAP_VERSION");
295 if (version != IDMAP_VERSION) {
297 DEBUG(0,("Upgrade of IDMAP_VERSION from %d to %d is not "
298 "possible with incomplete configuration\n",
299 version, IDMAP_VERSION));
300 ret = NT_STATUS_UNSUCCESSFUL;
303 if (db->transaction_start(db) != 0) {
304 DEBUG(0, ("Unable to start upgrade transaction!\n"));
305 ret = NT_STATUS_INTERNAL_DB_ERROR;
309 if (!idmap_tdb_upgrade(dom, db)) {
310 db->transaction_cancel(db);
311 DEBUG(0, ("Unable to open idmap database, it's in an old format, and upgrade failed!\n"));
312 ret = NT_STATUS_INTERNAL_DB_ERROR;
316 if (db->transaction_commit(db) != 0) {
317 DEBUG(0, ("Unable to commit upgrade transaction!\n"));
318 ret = NT_STATUS_INTERNAL_DB_ERROR;
323 ctx->db = talloc_move(ctx, &db);
325 ret = idmap_tdb_init_hwm(dom);
328 talloc_free(mem_ctx);
332 /**********************************************************************
333 IDMAP ALLOC TDB BACKEND
334 **********************************************************************/
336 /**********************************
338 **********************************/
340 struct idmap_tdb_allocate_id_context {
347 static NTSTATUS idmap_tdb_allocate_id_action(struct db_context *db,
351 struct idmap_tdb_allocate_id_context *state;
354 state = (struct idmap_tdb_allocate_id_context *)private_data;
356 hwm = dbwrap_fetch_int32(db, state->hwmkey);
358 ret = NT_STATUS_INTERNAL_DB_ERROR;
362 /* check it is in the range */
363 if (hwm > state->high_hwm) {
364 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
365 state->hwmtype, (unsigned long)state->high_hwm));
366 ret = NT_STATUS_UNSUCCESSFUL;
370 /* fetch a new id and increment it */
371 ret = dbwrap_trans_change_uint32_atomic(db, state->hwmkey, &hwm, 1);
372 if (!NT_STATUS_IS_OK(ret)) {
373 DEBUG(0, ("Fatal error while fetching a new %s value: %s\n!",
374 state->hwmtype, nt_errstr(ret)));
378 /* recheck it is in the range */
379 if (hwm > state->high_hwm) {
380 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
381 state->hwmtype, (unsigned long)state->high_hwm));
382 ret = NT_STATUS_UNSUCCESSFUL;
393 static NTSTATUS idmap_tdb_allocate_id(struct idmap_domain *dom,
401 struct idmap_tdb_allocate_id_context state;
402 struct idmap_tdb_context *ctx;
404 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
406 /* Get current high water mark */
420 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
421 return NT_STATUS_INVALID_PARAMETER;
424 high_hwm = dom->high_id;
427 state.high_hwm = high_hwm;
428 state.hwmtype = hwmtype;
429 state.hwmkey = hwmkey;
431 status = dbwrap_trans_do(ctx->db, idmap_tdb_allocate_id_action,
434 if (NT_STATUS_IS_OK(status)) {
436 DEBUG(10,("New %s = %d\n", hwmtype, state.hwm));
438 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
445 * Allocate a new unix-ID.
446 * For now this is for the default idmap domain only.
447 * Should be extended later on.
449 static NTSTATUS idmap_tdb_get_new_id(struct idmap_domain *dom,
454 if (!strequal(dom->name, "*")) {
455 DEBUG(3, ("idmap_tdb_get_new_id: "
456 "Refusing allocation of a new unixid for domain'%s'. "
457 "Currently only supported for the default "
460 return NT_STATUS_NOT_IMPLEMENTED;
463 ret = idmap_tdb_allocate_id(dom, id);
468 /**********************************************************************
469 IDMAP MAPPING TDB BACKEND
470 **********************************************************************/
472 /*****************************
473 Initialise idmap database.
474 *****************************/
476 static NTSTATUS idmap_tdb_db_init(struct idmap_domain *dom, const char *params)
479 struct idmap_tdb_context *ctx;
481 ctx = talloc(dom, struct idmap_tdb_context);
483 DEBUG(0, ("Out of memory!\n"));
484 return NT_STATUS_NO_MEMORY;
487 /* load backend specific configuration here: */
489 if (strequal(dom->name, "*")) {
494 dom->private_data = ctx;
496 ret = idmap_tdb_open_db(dom);
497 if ( ! NT_STATUS_IS_OK(ret)) {
510 * store a mapping in the database
513 struct idmap_tdb_set_mapping_context {
518 static NTSTATUS idmap_tdb_set_mapping_action(struct db_context *db,
522 struct idmap_tdb_set_mapping_context *state;
524 state = (struct idmap_tdb_set_mapping_context *)private_data;
526 DEBUG(10, ("Storing %s <-> %s map\n", state->ksidstr, state->kidstr));
528 ret = dbwrap_store_bystring(db, state->ksidstr,
529 string_term_tdb_data(state->kidstr),
531 if (!NT_STATUS_IS_OK(ret)) {
532 DEBUG(0, ("Error storing SID -> ID (%s -> %s): %s\n",
533 state->ksidstr, state->kidstr, nt_errstr(ret)));
537 ret = dbwrap_store_bystring(db, state->kidstr,
538 string_term_tdb_data(state->ksidstr),
540 if (!NT_STATUS_IS_OK(ret)) {
541 DEBUG(0, ("Error storing ID -> SID (%s -> %s): %s\n",
542 state->kidstr, state->ksidstr, nt_errstr(ret)));
546 DEBUG(10,("Stored %s <-> %s\n", state->ksidstr, state->kidstr));
553 static NTSTATUS idmap_tdb_set_mapping(struct idmap_domain *dom,
554 const struct id_map *map)
556 struct idmap_tdb_context *ctx;
558 char *ksidstr, *kidstr;
559 struct idmap_tdb_set_mapping_context state;
561 if (!map || !map->sid) {
562 return NT_STATUS_INVALID_PARAMETER;
565 ksidstr = kidstr = NULL;
567 /* TODO: should we filter a set_mapping using low/high filters ? */
569 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
571 switch (map->xid.type) {
574 kidstr = talloc_asprintf(ctx, "UID %lu",
575 (unsigned long)map->xid.id);
579 kidstr = talloc_asprintf(ctx, "GID %lu",
580 (unsigned long)map->xid.id);
584 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
585 return NT_STATUS_INVALID_PARAMETER;
588 if (kidstr == NULL) {
589 DEBUG(0, ("ERROR: Out of memory!\n"));
590 ret = NT_STATUS_NO_MEMORY;
594 ksidstr = sid_string_talloc(ctx, map->sid);
595 if (ksidstr == NULL) {
596 DEBUG(0, ("Out of memory!\n"));
597 ret = NT_STATUS_NO_MEMORY;
601 state.ksidstr = ksidstr;
602 state.kidstr = kidstr;
604 ret = dbwrap_trans_do(ctx->db, idmap_tdb_set_mapping_action, &state);
607 talloc_free(ksidstr);
612 /**********************************
613 Single id to sid lookup function.
614 **********************************/
616 static NTSTATUS idmap_tdb_id_to_sid(struct idmap_domain *dom, struct id_map *map)
621 struct idmap_tdb_context *ctx;
624 return NT_STATUS_INVALID_PARAMETER;
627 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
629 /* apply filters before checking */
630 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
631 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
632 map->xid.id, dom->low_id, dom->high_id));
633 return NT_STATUS_NONE_MAPPED;
636 switch (map->xid.type) {
639 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
643 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
647 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
648 return NT_STATUS_INVALID_PARAMETER;
651 /* final SAFE_FREE safe */
654 if (keystr == NULL) {
655 DEBUG(0, ("Out of memory!\n"));
656 ret = NT_STATUS_NO_MEMORY;
660 DEBUG(10,("Fetching record %s\n", keystr));
662 /* Check if the mapping exists */
663 data = dbwrap_fetch_bystring(ctx->db, NULL, keystr);
666 DEBUG(10,("Record %s not found\n", keystr));
667 ret = NT_STATUS_NONE_MAPPED;
671 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
672 DEBUG(10,("INVALID SID (%s) in record %s\n",
673 (const char *)data.dptr, keystr));
674 ret = NT_STATUS_INTERNAL_DB_ERROR;
678 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
682 talloc_free(data.dptr);
687 /**********************************
688 Single sid to id lookup function.
689 **********************************/
691 static NTSTATUS idmap_tdb_sid_to_id(struct idmap_domain *dom, struct id_map *map)
696 unsigned long rec_id = 0;
697 struct idmap_tdb_context *ctx;
698 TALLOC_CTX *tmp_ctx = talloc_stackframe();
700 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
702 keystr = sid_string_talloc(tmp_ctx, map->sid);
703 if (keystr == NULL) {
704 DEBUG(0, ("Out of memory!\n"));
705 ret = NT_STATUS_NO_MEMORY;
709 DEBUG(10,("Fetching record %s\n", keystr));
711 /* Check if sid is present in database */
712 data = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr);
714 DEBUG(10,("Record %s not found\n", keystr));
715 ret = NT_STATUS_NONE_MAPPED;
719 /* What type of record is this ? */
720 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
721 map->xid.id = rec_id;
722 map->xid.type = ID_TYPE_UID;
723 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
726 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
727 map->xid.id = rec_id;
728 map->xid.type = ID_TYPE_GID;
729 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
732 } else { /* Unknown record type ! */
733 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
734 ret = NT_STATUS_INTERNAL_DB_ERROR;
738 /* apply filters before returning result */
739 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
740 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
741 map->xid.id, dom->low_id, dom->high_id));
742 ret = NT_STATUS_NONE_MAPPED;
746 talloc_free(tmp_ctx);
750 /**********************************
751 lookup a set of unix ids.
752 **********************************/
754 static NTSTATUS idmap_tdb_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
756 struct idmap_tdb_context *ctx;
760 /* initialize the status to avoid suprise */
761 for (i = 0; ids[i]; i++) {
762 ids[i]->status = ID_UNKNOWN;
765 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
767 for (i = 0; ids[i]; i++) {
768 ret = idmap_tdb_id_to_sid(dom, ids[i]);
769 if ( ! NT_STATUS_IS_OK(ret)) {
771 /* if it is just a failed mapping continue */
772 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
774 /* make sure it is marked as unmapped */
775 ids[i]->status = ID_UNMAPPED;
779 /* some fatal error occurred, return immediately */
783 /* all ok, id is mapped */
784 ids[i]->status = ID_MAPPED;
793 /**********************************
794 lookup a set of sids.
795 **********************************/
797 static NTSTATUS idmap_tdb_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
799 struct idmap_tdb_context *ctx;
803 /* initialize the status to avoid suprise */
804 for (i = 0; ids[i]; i++) {
805 ids[i]->status = ID_UNKNOWN;
808 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
810 for (i = 0; ids[i]; i++) {
811 ret = idmap_tdb_sid_to_id(dom, ids[i]);
812 if ( ! NT_STATUS_IS_OK(ret)) {
814 /* if it is just a failed mapping continue */
815 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
817 /* make sure it is marked as unmapped */
818 ids[i]->status = ID_UNMAPPED;
822 /* some fatal error occurred, return immediately */
826 /* all ok, id is mapped */
827 ids[i]->status = ID_MAPPED;
836 /**********************************
837 Close the idmap tdb instance
838 **********************************/
840 static NTSTATUS idmap_tdb_close(struct idmap_domain *dom)
842 struct idmap_tdb_context *ctx;
844 if (dom->private_data) {
845 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
847 TALLOC_FREE(ctx->db);
852 static struct idmap_methods db_methods = {
853 .init = idmap_tdb_db_init,
854 .unixids_to_sids = idmap_tdb_unixids_to_sids,
855 .sids_to_unixids = idmap_tdb_sids_to_unixids,
856 .allocate_id = idmap_tdb_get_new_id,
857 .close_fn = idmap_tdb_close
860 NTSTATUS idmap_tdb_init(void)
862 DEBUG(10, ("calling idmap_tdb_init\n"));
864 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb", &db_methods);