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
10 Copyright (C) Michael Adam 2009-2010
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
33 #define DBGC_CLASS DBGC_IDMAP
35 /* idmap version determines auto-conversion - this is the database
36 structure version specifier. */
38 #define IDMAP_VERSION 2
40 struct idmap_tdb_context {
41 struct db_context *db;
42 struct idmap_rw_ops *rw_ops;
45 /* High water mark keys */
46 #define HWM_GROUP "GROUP HWM"
47 #define HWM_USER "USER HWM"
49 struct convert_fn_state {
50 struct db_context *db;
54 /*****************************************************************************
55 For idmap conversion: convert one record to new format
56 Ancient versions (eg 2.2.3a) of winbindd_idmap.tdb mapped DOMAINNAME/rid
58 *****************************************************************************/
59 static int convert_fn(struct db_record *rec, void *private_data)
61 struct winbindd_domain *domain;
69 struct convert_fn_state *s = (struct convert_fn_state *)private_data;
71 DEBUG(10,("Converting %s\n", (const char *)rec->key.dptr));
73 p = strchr((const char *)rec->key.dptr, '/');
78 fstrcpy(dom_name, (const char *)rec->key.dptr);
81 domain = find_domain_from_name(dom_name);
83 /* We must delete the old record. */
84 DEBUG(0,("Unable to find domain %s\n", dom_name ));
85 DEBUG(0,("deleting record %s\n", (const char *)rec->key.dptr ));
87 status = rec->delete_rec(rec);
88 if (!NT_STATUS_IS_OK(status)) {
89 DEBUG(0, ("Unable to delete record %s:%s\n",
90 (const char *)rec->key.dptr,
101 sid_compose(&sid, &domain->sid, rid);
103 sid_to_fstring(keystr, &sid);
104 key2 = string_term_tdb_data(keystr);
106 status = dbwrap_store(s->db, key2, rec->value, TDB_INSERT);
107 if (!NT_STATUS_IS_OK(status)) {
108 DEBUG(0,("Unable to add record %s:%s\n",
109 (const char *)key2.dptr,
115 status = dbwrap_store(s->db, rec->value, key2, TDB_REPLACE);
116 if (!NT_STATUS_IS_OK(status)) {
117 DEBUG(0,("Unable to update record %s:%s\n",
118 (const char *)rec->value.dptr,
124 status = rec->delete_rec(rec);
125 if (!NT_STATUS_IS_OK(status)) {
126 DEBUG(0,("Unable to delete record %s:%s\n",
127 (const char *)rec->key.dptr,
136 /*****************************************************************************
137 Convert the idmap database from an older version.
138 *****************************************************************************/
140 static bool idmap_tdb_upgrade(struct idmap_domain *dom, struct db_context *db)
143 bool bigendianheader;
144 struct convert_fn_state s;
146 DEBUG(0, ("Upgrading winbindd_idmap.tdb from an old version\n"));
148 bigendianheader = (db->get_flags(db) & TDB_BIGENDIAN) ? True : False;
150 vers = dbwrap_fetch_int32(db, "IDMAP_VERSION");
152 if (((vers == -1) && bigendianheader) || (IREV(vers) == IDMAP_VERSION)) {
153 /* Arrggghh ! Bytereversed or old big-endian - make order independent ! */
155 * high and low records were created on a
156 * big endian machine and will need byte-reversing.
161 wm = dbwrap_fetch_int32(db, HWM_USER);
169 if (dbwrap_store_int32(db, HWM_USER, wm) == -1) {
170 DEBUG(0, ("Unable to byteswap user hwm in idmap database\n"));
174 wm = dbwrap_fetch_int32(db, HWM_GROUP);
181 if (dbwrap_store_int32(db, HWM_GROUP, wm) == -1) {
182 DEBUG(0, ("Unable to byteswap group hwm in idmap database\n"));
190 /* the old format stored as DOMAIN/rid - now we store the SID direct */
191 db->traverse(db, convert_fn, &s);
194 DEBUG(0, ("Problem during conversion\n"));
198 if (dbwrap_store_int32(db, "IDMAP_VERSION", IDMAP_VERSION) == -1) {
199 DEBUG(0, ("Unable to store idmap version in databse\n"));
206 static NTSTATUS idmap_tdb_init_hwm(struct idmap_domain *dom)
211 bool update_uid = false;
212 bool update_gid = false;
213 struct idmap_tdb_context *ctx;
215 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
217 low_uid = dbwrap_fetch_int32(ctx->db, HWM_USER);
218 if (low_uid == -1 || low_uid < dom->low_id) {
222 low_gid = dbwrap_fetch_int32(ctx->db, HWM_GROUP);
223 if (low_gid == -1 || low_gid < dom->low_id) {
227 if (!update_uid && !update_gid) {
231 if (ctx->db->transaction_start(ctx->db) != 0) {
232 DEBUG(0, ("Unable to start upgrade transaction!\n"));
233 return NT_STATUS_INTERNAL_DB_ERROR;
237 ret = dbwrap_store_int32(ctx->db, HWM_USER, dom->low_id);
239 ctx->db->transaction_cancel(ctx->db);
240 DEBUG(0, ("Unable to initialise user hwm in idmap "
242 return NT_STATUS_INTERNAL_DB_ERROR;
247 ret = dbwrap_store_int32(ctx->db, HWM_GROUP, dom->low_id);
249 ctx->db->transaction_cancel(ctx->db);
250 DEBUG(0, ("Unable to initialise group hwm in idmap "
252 return NT_STATUS_INTERNAL_DB_ERROR;
256 if (ctx->db->transaction_commit(ctx->db) != 0) {
257 DEBUG(0, ("Unable to commit upgrade transaction!\n"));
258 return NT_STATUS_INTERNAL_DB_ERROR;
264 static NTSTATUS idmap_tdb_open_db(struct idmap_domain *dom)
268 char *tdbfile = NULL;
269 struct db_context *db = NULL;
271 bool config_error = false;
272 struct idmap_tdb_context *ctx;
274 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
277 /* it is already open */
281 /* use our own context here */
282 mem_ctx = talloc_stackframe();
284 /* use the old database if present */
285 tdbfile = state_path("winbindd_idmap.tdb");
287 DEBUG(0, ("Out of memory!\n"));
288 ret = NT_STATUS_NO_MEMORY;
292 DEBUG(10,("Opening tdbfile %s\n", tdbfile ));
294 /* Open idmap repository */
295 db = db_open(mem_ctx, tdbfile, 0, TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
297 DEBUG(0, ("Unable to open idmap database\n"));
298 ret = NT_STATUS_UNSUCCESSFUL;
302 /* check against earlier versions */
303 version = dbwrap_fetch_int32(db, "IDMAP_VERSION");
304 if (version != IDMAP_VERSION) {
306 DEBUG(0,("Upgrade of IDMAP_VERSION from %d to %d is not "
307 "possible with incomplete configuration\n",
308 version, IDMAP_VERSION));
309 ret = NT_STATUS_UNSUCCESSFUL;
312 if (db->transaction_start(db) != 0) {
313 DEBUG(0, ("Unable to start upgrade transaction!\n"));
314 ret = NT_STATUS_INTERNAL_DB_ERROR;
318 if (!idmap_tdb_upgrade(dom, db)) {
319 db->transaction_cancel(db);
320 DEBUG(0, ("Unable to open idmap database, it's in an old format, and upgrade failed!\n"));
321 ret = NT_STATUS_INTERNAL_DB_ERROR;
325 if (db->transaction_commit(db) != 0) {
326 DEBUG(0, ("Unable to commit upgrade transaction!\n"));
327 ret = NT_STATUS_INTERNAL_DB_ERROR;
332 ctx->db = talloc_move(ctx, &db);
334 ret = idmap_tdb_init_hwm(dom);
337 talloc_free(mem_ctx);
341 /**********************************************************************
342 IDMAP ALLOC TDB BACKEND
343 **********************************************************************/
345 /**********************************
347 **********************************/
349 struct idmap_tdb_allocate_id_context {
356 static NTSTATUS idmap_tdb_allocate_id_action(struct db_context *db,
360 struct idmap_tdb_allocate_id_context *state;
363 state = (struct idmap_tdb_allocate_id_context *)private_data;
365 hwm = dbwrap_fetch_int32(db, state->hwmkey);
367 ret = NT_STATUS_INTERNAL_DB_ERROR;
371 /* check it is in the range */
372 if (hwm > state->high_hwm) {
373 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
374 state->hwmtype, (unsigned long)state->high_hwm));
375 ret = NT_STATUS_UNSUCCESSFUL;
379 /* fetch a new id and increment it */
380 ret = dbwrap_trans_change_uint32_atomic(db, state->hwmkey, &hwm, 1);
381 if (!NT_STATUS_IS_OK(ret)) {
382 DEBUG(0, ("Fatal error while fetching a new %s value: %s\n!",
383 state->hwmtype, nt_errstr(ret)));
387 /* recheck it is in the range */
388 if (hwm > state->high_hwm) {
389 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
390 state->hwmtype, (unsigned long)state->high_hwm));
391 ret = NT_STATUS_UNSUCCESSFUL;
402 static NTSTATUS idmap_tdb_allocate_id(struct idmap_domain *dom,
410 struct idmap_tdb_allocate_id_context state;
411 struct idmap_tdb_context *ctx;
413 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
415 /* Get current high water mark */
429 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
430 return NT_STATUS_INVALID_PARAMETER;
433 high_hwm = dom->high_id;
436 state.high_hwm = high_hwm;
437 state.hwmtype = hwmtype;
438 state.hwmkey = hwmkey;
440 status = dbwrap_trans_do(ctx->db, idmap_tdb_allocate_id_action,
443 if (NT_STATUS_IS_OK(status)) {
445 DEBUG(10,("New %s = %d\n", hwmtype, state.hwm));
447 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
454 * Allocate a new unix-ID.
455 * For now this is for the default idmap domain only.
456 * Should be extended later on.
458 static NTSTATUS idmap_tdb_get_new_id(struct idmap_domain *dom,
463 if (!strequal(dom->name, "*")) {
464 DEBUG(3, ("idmap_tdb_get_new_id: "
465 "Refusing allocation of a new unixid for domain'%s'. "
466 "Currently only supported for the default "
469 return NT_STATUS_NOT_IMPLEMENTED;
472 ret = idmap_tdb_allocate_id(dom, id);
477 /**********************************************************************
478 IDMAP MAPPING TDB BACKEND
479 **********************************************************************/
481 /*****************************
482 Initialise idmap database.
483 *****************************/
485 static NTSTATUS idmap_tdb_set_mapping(struct idmap_domain *dom,
486 const struct id_map *map);
488 static NTSTATUS idmap_tdb_db_init(struct idmap_domain *dom, const char *params)
491 struct idmap_tdb_context *ctx;
493 DEBUG(10, ("idmap_tdb_db_init called for domain '%s'\n", dom->name));
495 ctx = talloc_zero(dom, struct idmap_tdb_context);
497 DEBUG(0, ("Out of memory!\n"));
498 return NT_STATUS_NO_MEMORY;
501 /* load backend specific configuration here: */
503 if (strequal(dom->name, "*")) {
508 ctx->rw_ops = talloc_zero(ctx, struct idmap_rw_ops);
509 if (ctx->rw_ops == NULL) {
510 DEBUG(0, ("Out of memory!\n"));
511 ret = NT_STATUS_NO_MEMORY;
515 ctx->rw_ops->get_new_id = idmap_tdb_get_new_id;
516 ctx->rw_ops->set_mapping = idmap_tdb_set_mapping;
518 dom->private_data = ctx;
520 ret = idmap_tdb_open_db(dom);
521 if ( ! NT_STATUS_IS_OK(ret)) {
534 * store a mapping in the database
537 struct idmap_tdb_set_mapping_context {
542 static NTSTATUS idmap_tdb_set_mapping_action(struct db_context *db,
546 struct idmap_tdb_set_mapping_context *state;
548 state = (struct idmap_tdb_set_mapping_context *)private_data;
550 DEBUG(10, ("Storing %s <-> %s map\n", state->ksidstr, state->kidstr));
552 ret = dbwrap_store_bystring(db, state->ksidstr,
553 string_term_tdb_data(state->kidstr),
555 if (!NT_STATUS_IS_OK(ret)) {
556 DEBUG(0, ("Error storing SID -> ID (%s -> %s): %s\n",
557 state->ksidstr, state->kidstr, nt_errstr(ret)));
561 ret = dbwrap_store_bystring(db, state->kidstr,
562 string_term_tdb_data(state->ksidstr),
564 if (!NT_STATUS_IS_OK(ret)) {
565 DEBUG(0, ("Error storing ID -> SID (%s -> %s): %s\n",
566 state->kidstr, state->ksidstr, nt_errstr(ret)));
570 DEBUG(10,("Stored %s <-> %s\n", state->ksidstr, state->kidstr));
577 static NTSTATUS idmap_tdb_set_mapping(struct idmap_domain *dom,
578 const struct id_map *map)
580 struct idmap_tdb_context *ctx;
582 char *ksidstr, *kidstr;
583 struct idmap_tdb_set_mapping_context state;
585 if (!map || !map->sid) {
586 return NT_STATUS_INVALID_PARAMETER;
589 ksidstr = kidstr = NULL;
591 /* TODO: should we filter a set_mapping using low/high filters ? */
593 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
595 switch (map->xid.type) {
598 kidstr = talloc_asprintf(ctx, "UID %lu",
599 (unsigned long)map->xid.id);
603 kidstr = talloc_asprintf(ctx, "GID %lu",
604 (unsigned long)map->xid.id);
608 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
609 return NT_STATUS_INVALID_PARAMETER;
612 if (kidstr == NULL) {
613 DEBUG(0, ("ERROR: Out of memory!\n"));
614 ret = NT_STATUS_NO_MEMORY;
618 ksidstr = sid_string_talloc(ctx, map->sid);
619 if (ksidstr == NULL) {
620 DEBUG(0, ("Out of memory!\n"));
621 ret = NT_STATUS_NO_MEMORY;
625 state.ksidstr = ksidstr;
626 state.kidstr = kidstr;
628 ret = dbwrap_trans_do(ctx->db, idmap_tdb_set_mapping_action, &state);
631 talloc_free(ksidstr);
637 * Create a new mapping for an unmapped SID, also allocating a new ID.
638 * This should be run inside a transaction.
641 * Properly integrate this with multi domain idmap config:
642 * Currently, the allocator is default-config only.
644 static NTSTATUS idmap_tdb_new_mapping(struct idmap_domain *dom, struct id_map *map)
647 struct idmap_tdb_context *ctx;
649 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
651 ret = idmap_rw_new_mapping(dom, ctx->rw_ops, map);
657 /**********************************
658 Single id to sid lookup function.
659 **********************************/
661 static NTSTATUS idmap_tdb_id_to_sid(struct idmap_domain *dom, struct id_map *map)
666 struct idmap_tdb_context *ctx;
669 return NT_STATUS_INVALID_PARAMETER;
672 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
674 /* apply filters before checking */
675 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
676 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
677 map->xid.id, dom->low_id, dom->high_id));
678 return NT_STATUS_NONE_MAPPED;
681 switch (map->xid.type) {
684 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
688 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
692 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
693 return NT_STATUS_INVALID_PARAMETER;
696 /* final SAFE_FREE safe */
699 if (keystr == NULL) {
700 DEBUG(0, ("Out of memory!\n"));
701 ret = NT_STATUS_NO_MEMORY;
705 DEBUG(10,("Fetching record %s\n", keystr));
707 /* Check if the mapping exists */
708 data = dbwrap_fetch_bystring(ctx->db, NULL, keystr);
711 DEBUG(10,("Record %s not found\n", keystr));
712 ret = NT_STATUS_NONE_MAPPED;
716 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
717 DEBUG(10,("INVALID SID (%s) in record %s\n",
718 (const char *)data.dptr, keystr));
719 ret = NT_STATUS_INTERNAL_DB_ERROR;
723 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
727 talloc_free(data.dptr);
732 /**********************************
733 Single sid to id lookup function.
734 **********************************/
736 static NTSTATUS idmap_tdb_sid_to_id(struct idmap_domain *dom, struct id_map *map)
741 unsigned long rec_id = 0;
742 struct idmap_tdb_context *ctx;
743 TALLOC_CTX *tmp_ctx = talloc_stackframe();
745 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
747 keystr = sid_string_talloc(tmp_ctx, map->sid);
748 if (keystr == NULL) {
749 DEBUG(0, ("Out of memory!\n"));
750 ret = NT_STATUS_NO_MEMORY;
754 DEBUG(10,("Fetching record %s\n", keystr));
756 /* Check if sid is present in database */
757 data = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr);
759 DEBUG(10,("Record %s not found\n", keystr));
760 ret = NT_STATUS_NONE_MAPPED;
764 /* What type of record is this ? */
765 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
766 map->xid.id = rec_id;
767 map->xid.type = ID_TYPE_UID;
768 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
771 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
772 map->xid.id = rec_id;
773 map->xid.type = ID_TYPE_GID;
774 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
777 } else { /* Unknown record type ! */
778 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
779 ret = NT_STATUS_INTERNAL_DB_ERROR;
783 /* apply filters before returning result */
784 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
785 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
786 map->xid.id, dom->low_id, dom->high_id));
787 ret = NT_STATUS_NONE_MAPPED;
791 talloc_free(tmp_ctx);
795 /**********************************
796 lookup a set of unix ids.
797 **********************************/
799 static NTSTATUS idmap_tdb_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
801 struct idmap_tdb_context *ctx;
805 /* initialize the status to avoid suprise */
806 for (i = 0; ids[i]; i++) {
807 ids[i]->status = ID_UNKNOWN;
810 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
812 for (i = 0; ids[i]; i++) {
813 ret = idmap_tdb_id_to_sid(dom, ids[i]);
814 if ( ! NT_STATUS_IS_OK(ret)) {
816 /* if it is just a failed mapping continue */
817 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
819 /* make sure it is marked as unmapped */
820 ids[i]->status = ID_UNMAPPED;
824 /* some fatal error occurred, return immediately */
828 /* all ok, id is mapped */
829 ids[i]->status = ID_MAPPED;
838 /**********************************
839 lookup a set of sids.
840 **********************************/
842 struct idmap_tdb_sids_to_unixids_context {
843 struct idmap_domain *dom;
845 bool allocate_unmapped;
848 static NTSTATUS idmap_tdb_sids_to_unixids_action(struct db_context *db,
851 struct idmap_tdb_sids_to_unixids_context *state;
853 NTSTATUS ret = NT_STATUS_OK;
855 state = (struct idmap_tdb_sids_to_unixids_context *)private_data;
857 DEBUG(10, ("idmap_tdb_sids_to_unixids_action: "
858 " domain: [%s], allocate: %s\n",
860 state->allocate_unmapped ? "yes" : "no"));
862 for (i = 0; state->ids[i]; i++) {
863 if ((state->ids[i]->status == ID_UNKNOWN) ||
864 /* retry if we could not map in previous run: */
865 (state->ids[i]->status == ID_UNMAPPED))
869 ret2 = idmap_tdb_sid_to_id(state->dom, state->ids[i]);
870 if (!NT_STATUS_IS_OK(ret2)) {
872 /* if it is just a failed mapping, continue */
873 if (NT_STATUS_EQUAL(ret2, NT_STATUS_NONE_MAPPED)) {
875 /* make sure it is marked as unmapped */
876 state->ids[i]->status = ID_UNMAPPED;
877 ret = STATUS_SOME_UNMAPPED;
879 /* some fatal error occurred, return immediately */
884 /* all ok, id is mapped */
885 state->ids[i]->status = ID_MAPPED;
889 if ((state->ids[i]->status == ID_UNMAPPED) &&
890 state->allocate_unmapped)
892 ret = idmap_tdb_new_mapping(state->dom, state->ids[i]);
893 if (!NT_STATUS_IS_OK(ret)) {
903 static NTSTATUS idmap_tdb_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
905 struct idmap_tdb_context *ctx;
908 struct idmap_tdb_sids_to_unixids_context state;
910 /* initialize the status to avoid suprise */
911 for (i = 0; ids[i]; i++) {
912 ids[i]->status = ID_UNKNOWN;
915 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
919 state.allocate_unmapped = false;
921 ret = idmap_tdb_sids_to_unixids_action(ctx->db, &state);
923 if (NT_STATUS_EQUAL(ret, STATUS_SOME_UNMAPPED) && !dom->read_only) {
924 state.allocate_unmapped = true;
925 ret = dbwrap_trans_do(ctx->db,
926 idmap_tdb_sids_to_unixids_action,
934 /**********************************
935 Close the idmap tdb instance
936 **********************************/
938 static NTSTATUS idmap_tdb_close(struct idmap_domain *dom)
940 struct idmap_tdb_context *ctx;
942 if (dom->private_data) {
943 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
945 TALLOC_FREE(ctx->db);
950 static struct idmap_methods db_methods = {
951 .init = idmap_tdb_db_init,
952 .unixids_to_sids = idmap_tdb_unixids_to_sids,
953 .sids_to_unixids = idmap_tdb_sids_to_unixids,
954 .allocate_id = idmap_tdb_get_new_id,
955 .close_fn = idmap_tdb_close
958 NTSTATUS idmap_tdb_init(void)
960 DEBUG(10, ("calling idmap_tdb_init\n"));
962 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb", &db_methods);