2 Unix SMB/CIFS implementation.
4 idmap TDB2 backend, used for clustered Samba setups.
6 This uses dbwrap to access tdb files. The location can be set
7 using tdb:idmap2.tdb =" in smb.conf
9 Copyright (C) Andrew Tridgell 2007
11 This is heavily based upon idmap_tdb.c, which is:
13 Copyright (C) Tim Potter 2000
14 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
15 Copyright (C) Jeremy Allison 2006
16 Copyright (C) Simo Sorce 2003-2006
18 This program is free software; you can redistribute it and/or modify
19 it under the terms of the GNU General Public License as published by
20 the Free Software Foundation; either version 2 of the License, or
21 (at your option) any later version.
23 This program is distributed in the hope that it will be useful,
24 but WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 GNU General Public License for more details.
28 You should have received a copy of the GNU General Public License
29 along with this program; if not, write to the Free Software
30 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
37 #define DBGC_CLASS DBGC_IDMAP
39 /* High water mark keys */
40 #define HWM_GROUP "GROUP HWM"
41 #define HWM_USER "USER HWM"
43 static struct idmap_tdb2_state {
44 /* User and group id pool */
45 uid_t low_uid, high_uid; /* Range of uids to allocate */
46 gid_t low_gid, high_gid; /* Range of gids to allocate */
47 const char *idmap_script;
52 /* handle to the permanent tdb */
53 static struct db_context *idmap_tdb2;
55 static NTSTATUS idmap_tdb2_alloc_load(void);
58 open the permanent tdb
60 static NTSTATUS idmap_tdb2_open_db(void)
65 /* its already open */
69 db_path = lp_parm_talloc_string(-1, "tdb", "idmap2.tdb", NULL);
70 if (db_path == NULL) {
71 /* fall back to the private directory, which, despite
72 its name, is usually on shared storage */
73 db_path = talloc_asprintf(NULL, "%s/idmap2.tdb", lp_private_dir());
75 NT_STATUS_HAVE_NO_MEMORY(db_path);
77 /* Open idmap repository */
78 idmap_tdb2 = db_open(NULL, db_path, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0644);
81 if (idmap_tdb2 == NULL) {
82 DEBUG(0, ("Unable to open idmap_tdb2 database '%s'\n",
84 return NT_STATUS_UNSUCCESSFUL;
87 /* load the ranges and high/low water marks */
88 return idmap_tdb2_alloc_load();
93 load the idmap allocation ranges and high/low water marks
95 static NTSTATUS idmap_tdb2_alloc_load(void)
102 uint32 low_id, high_id;
104 /* see if a idmap script is configured */
105 idmap_tdb2_state.idmap_script = lp_parm_const_string(-1, "idmap",
108 if (idmap_tdb2_state.idmap_script) {
109 DEBUG(1, ("using idmap script '%s'\n",
110 idmap_tdb2_state.idmap_script));
115 /* Create high water marks for group and user id */
116 if (!lp_idmap_uid(&low_uid, &high_uid)
117 || !lp_idmap_gid(&low_gid, &high_gid)) {
118 DEBUG(1, ("idmap uid or idmap gid missing\n"));
119 return NT_STATUS_UNSUCCESSFUL;
122 idmap_tdb2_state.low_uid = low_uid;
123 idmap_tdb2_state.high_uid = high_uid;
124 idmap_tdb2_state.low_gid = low_gid;
125 idmap_tdb2_state.high_gid = high_gid;
127 if (idmap_tdb2_state.high_uid <= idmap_tdb2_state.low_uid) {
128 DEBUG(1, ("idmap uid range missing or invalid\n"));
129 DEBUGADD(1, ("idmap will be unable to map foreign SIDs\n"));
130 return NT_STATUS_UNSUCCESSFUL;
133 if (((low_id = dbwrap_fetch_int32(idmap_tdb2,
135 (low_id < idmap_tdb2_state.low_uid)) {
136 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
137 idmap_tdb2, HWM_USER,
138 idmap_tdb2_state.low_uid))) {
139 DEBUG(0, ("Unable to initialise user hwm in idmap "
141 return NT_STATUS_INTERNAL_DB_ERROR;
145 if (idmap_tdb2_state.high_gid <= idmap_tdb2_state.low_gid) {
146 DEBUG(1, ("idmap gid range missing or invalid\n"));
147 DEBUGADD(1, ("idmap will be unable to map foreign SIDs\n"));
148 return NT_STATUS_UNSUCCESSFUL;
151 if (((low_id = dbwrap_fetch_int32(idmap_tdb2,
152 HWM_GROUP)) == -1) ||
153 (low_id < idmap_tdb2_state.low_gid)) {
154 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
155 idmap_tdb2, HWM_GROUP,
156 idmap_tdb2_state.low_gid))) {
157 DEBUG(0, ("Unable to initialise group hwm in idmap "
159 return NT_STATUS_INTERNAL_DB_ERROR;
168 Initialise idmap alloc database.
170 static NTSTATUS idmap_tdb2_alloc_init(const char *params)
172 /* nothing to do - we want to avoid opening the permanent
173 database if possible. Instead we load the params when we
182 static NTSTATUS idmap_tdb2_allocate_id(struct unixid *xid)
191 /* Get current high water mark */
197 high_hwm = idmap_tdb2_state.high_uid;
203 high_hwm = idmap_tdb2_state.high_gid;
207 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
208 return NT_STATUS_INVALID_PARAMETER;
211 res = idmap_tdb2->transaction_start(idmap_tdb2);
213 DEBUG(1,(__location__ " Failed to start transaction\n"));
214 return NT_STATUS_UNSUCCESSFUL;
217 if ((hwm = dbwrap_fetch_int32(idmap_tdb2, hwmkey)) == -1) {
218 idmap_tdb2->transaction_cancel(idmap_tdb2);
219 return NT_STATUS_INTERNAL_DB_ERROR;
222 /* check it is in the range */
223 if (hwm > high_hwm) {
224 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
225 hwmtype, (unsigned long)high_hwm));
226 idmap_tdb2->transaction_cancel(idmap_tdb2);
227 return NT_STATUS_UNSUCCESSFUL;
230 /* fetch a new id and increment it */
231 ret = dbwrap_change_uint32_atomic(idmap_tdb2, hwmkey, &hwm, 1);
233 DEBUG(1, ("Fatal error while fetching a new %s value\n!", hwmtype));
234 idmap_tdb2->transaction_cancel(idmap_tdb2);
235 return NT_STATUS_UNSUCCESSFUL;
238 /* recheck it is in the range */
239 if (hwm > high_hwm) {
240 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
241 hwmtype, (unsigned long)high_hwm));
242 idmap_tdb2->transaction_cancel(idmap_tdb2);
243 return NT_STATUS_UNSUCCESSFUL;
246 res = idmap_tdb2->transaction_commit(idmap_tdb2);
248 DEBUG(1,(__location__ " Failed to commit transaction\n"));
249 return NT_STATUS_UNSUCCESSFUL;
253 DEBUG(10,("New %s = %d\n", hwmtype, hwm));
259 Get current highest id.
261 static NTSTATUS idmap_tdb2_get_hwm(struct unixid *xid)
268 /* Get current high water mark */
274 high_hwm = idmap_tdb2_state.high_uid;
280 high_hwm = idmap_tdb2_state.high_gid;
284 return NT_STATUS_INVALID_PARAMETER;
287 if ((hwm = dbwrap_fetch_int32(idmap_tdb2, hwmkey)) == -1) {
288 return NT_STATUS_INTERNAL_DB_ERROR;
293 /* Warn if it is out of range */
294 if (hwm >= high_hwm) {
295 DEBUG(0, ("Warning: %s range full!! (max: %lu)\n",
296 hwmtype, (unsigned long)high_hwm));
305 static NTSTATUS idmap_tdb2_set_hwm(struct unixid *xid)
307 /* not supported, or we would invalidate the cache tdb on
309 DEBUG(0,("idmap_tdb2_set_hwm not supported\n"));
310 return NT_STATUS_NOT_SUPPORTED;
316 static NTSTATUS idmap_tdb2_alloc_close(void)
318 /* don't actually close it */
323 IDMAP MAPPING TDB BACKEND
325 struct idmap_tdb2_context {
326 uint32_t filter_low_id;
327 uint32_t filter_high_id;
331 Initialise idmap database.
333 static NTSTATUS idmap_tdb2_db_init(struct idmap_domain *dom,
337 struct idmap_tdb2_context *ctx;
338 char *config_option = NULL;
342 status = idmap_tdb2_open_db();
343 NT_STATUS_NOT_OK_RETURN(status);
345 ctx = talloc(dom, struct idmap_tdb2_context);
347 DEBUG(0, ("Out of memory!\n"));
348 return NT_STATUS_NO_MEMORY;
351 config_option = talloc_asprintf(ctx, "idmap config %s", dom->name);
352 if ( ! config_option) {
353 DEBUG(0, ("Out of memory!\n"));
354 ret = NT_STATUS_NO_MEMORY;
358 range = lp_parm_const_string(-1, config_option, "range", NULL);
360 (sscanf(range, "%u - %u", &ctx->filter_low_id, &ctx->filter_high_id) != 2) ||
361 (ctx->filter_low_id > ctx->filter_high_id)) {
362 ctx->filter_low_id = 0;
363 ctx->filter_high_id = 0;
366 dom->private_data = ctx;
368 talloc_free(config_option);
378 run a script to perform a mapping
380 The script should the following command lines:
386 and should return one of the following as a single line of text
392 static NTSTATUS idmap_tdb2_script(struct idmap_tdb2_context *ctx, struct id_map *map,
393 const char *fmt, ...)
401 cmd = talloc_asprintf(ctx, "%s ", idmap_tdb2_state.idmap_script);
402 NT_STATUS_HAVE_NO_MEMORY(cmd);
405 cmd = talloc_vasprintf_append(cmd, fmt, ap);
407 NT_STATUS_HAVE_NO_MEMORY(cmd);
412 return NT_STATUS_NONE_MAPPED;
415 if (fgets(line, sizeof(line)-1, p) == NULL) {
417 return NT_STATUS_NONE_MAPPED;
421 DEBUG(10,("idmap script gave: %s\n", line));
423 if (sscanf(line, "UID:%lu", &v) == 1) {
425 map->xid.type = ID_TYPE_UID;
426 } else if (sscanf(line, "GID:%lu", &v) == 1) {
428 map->xid.type = ID_TYPE_GID;
429 } else if (strncmp(line, "SID:S-", 6) == 0) {
430 if (!string_to_sid(map->sid, &line[4])) {
431 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
432 line, idmap_tdb2_state.idmap_script));
433 return NT_STATUS_NONE_MAPPED;
436 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
437 line, idmap_tdb2_state.idmap_script));
438 return NT_STATUS_NONE_MAPPED;
447 Single id to sid lookup function.
449 static NTSTATUS idmap_tdb2_id_to_sid(struct idmap_tdb2_context *ctx, struct id_map *map)
456 return NT_STATUS_INVALID_PARAMETER;
459 /* apply filters before checking */
460 if ((ctx->filter_low_id && (map->xid.id < ctx->filter_low_id)) ||
461 (ctx->filter_high_id && (map->xid.id > ctx->filter_high_id))) {
462 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
463 map->xid.id, ctx->filter_low_id, ctx->filter_high_id));
464 return NT_STATUS_NONE_MAPPED;
467 switch (map->xid.type) {
470 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
474 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
478 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
479 return NT_STATUS_INVALID_PARAMETER;
482 /* final SAFE_FREE safe */
485 if (keystr == NULL) {
486 DEBUG(0, ("Out of memory!\n"));
487 ret = NT_STATUS_NO_MEMORY;
491 DEBUG(10,("Fetching record %s\n", keystr));
493 /* Check if the mapping exists */
494 data = dbwrap_fetch_bystring(idmap_tdb2, keystr, keystr);
499 DEBUG(10,("Record %s not found\n", keystr));
500 if (idmap_tdb2_state.idmap_script == NULL) {
501 ret = NT_STATUS_NONE_MAPPED;
505 ret = idmap_tdb2_script(ctx, map, "IDTOSID %s", keystr);
507 /* store it on shared storage */
508 if (!NT_STATUS_IS_OK(ret)) {
512 if (sid_to_fstring(sidstr, map->sid)) {
513 /* both forward and reverse mappings */
514 dbwrap_store_bystring(idmap_tdb2, keystr,
515 string_term_tdb_data(sidstr),
517 dbwrap_store_bystring(idmap_tdb2, sidstr,
518 string_term_tdb_data(keystr),
524 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
525 DEBUG(10,("INVALID SID (%s) in record %s\n",
526 (const char *)data.dptr, keystr));
527 ret = NT_STATUS_INTERNAL_DB_ERROR;
531 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
541 Single sid to id lookup function.
543 static NTSTATUS idmap_tdb2_sid_to_id(struct idmap_tdb2_context *ctx, struct id_map *map)
548 unsigned long rec_id = 0;
550 if ((keystr = sid_string_talloc(ctx, map->sid)) == NULL) {
551 DEBUG(0, ("Out of memory!\n"));
552 ret = NT_STATUS_NO_MEMORY;
556 DEBUG(10,("Fetching record %s\n", keystr));
558 /* Check if sid is present in database */
559 data = dbwrap_fetch_bystring(idmap_tdb2, keystr, keystr);
563 DEBUG(10,(__location__ " Record %s not found\n", keystr));
565 if (idmap_tdb2_state.idmap_script == NULL) {
566 ret = NT_STATUS_NONE_MAPPED;
570 ret = idmap_tdb2_script(ctx, map, "SIDTOID %s", keystr);
571 /* store it on shared storage */
572 if (!NT_STATUS_IS_OK(ret)) {
576 snprintf(idstr, sizeof(idstr), "%cID %lu",
577 map->xid.type == ID_TYPE_UID?'U':'G',
578 (unsigned long)map->xid.id);
579 /* store both forward and reverse mappings */
580 dbwrap_store_bystring(idmap_tdb2, keystr, string_term_tdb_data(idstr),
582 dbwrap_store_bystring(idmap_tdb2, idstr, string_term_tdb_data(keystr),
587 /* What type of record is this ? */
588 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
589 map->xid.id = rec_id;
590 map->xid.type = ID_TYPE_UID;
591 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
594 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
595 map->xid.id = rec_id;
596 map->xid.type = ID_TYPE_GID;
597 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
600 } else { /* Unknown record type ! */
601 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
602 ret = NT_STATUS_INTERNAL_DB_ERROR;
605 /* apply filters before returning result */
606 if ((ctx->filter_low_id && (map->xid.id < ctx->filter_low_id)) ||
607 (ctx->filter_high_id && (map->xid.id > ctx->filter_high_id))) {
608 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
609 map->xid.id, ctx->filter_low_id, ctx->filter_high_id));
610 ret = NT_STATUS_NONE_MAPPED;
619 lookup a set of unix ids.
621 static NTSTATUS idmap_tdb2_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
623 struct idmap_tdb2_context *ctx;
627 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
629 for (i = 0; ids[i]; i++) {
630 ret = idmap_tdb2_id_to_sid(ctx, ids[i]);
631 if ( ! NT_STATUS_IS_OK(ret)) {
633 /* if it is just a failed mapping continue */
634 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
636 /* make sure it is marked as unmapped */
637 ids[i]->status = ID_UNMAPPED;
641 /* some fatal error occurred, return immediately */
645 /* all ok, id is mapped */
646 ids[i]->status = ID_MAPPED;
656 lookup a set of sids.
658 static NTSTATUS idmap_tdb2_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
660 struct idmap_tdb2_context *ctx;
664 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
666 for (i = 0; ids[i]; i++) {
667 ret = idmap_tdb2_sid_to_id(ctx, ids[i]);
668 if ( ! NT_STATUS_IS_OK(ret)) {
670 /* if it is just a failed mapping continue */
671 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
673 /* make sure it is marked as unmapped */
674 ids[i]->status = ID_UNMAPPED;
678 /* some fatal error occurred, return immediately */
682 /* all ok, id is mapped */
683 ids[i]->status = ID_MAPPED;
696 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom, const struct id_map *map)
698 struct idmap_tdb2_context *ctx;
701 char *ksidstr, *kidstr;
703 bool started_transaction = false;
705 if (!map || !map->sid) {
706 return NT_STATUS_INVALID_PARAMETER;
709 ksidstr = kidstr = NULL;
711 /* TODO: should we filter a set_mapping using low/high filters ? */
713 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
715 switch (map->xid.type) {
718 kidstr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
722 kidstr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
726 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
727 return NT_STATUS_INVALID_PARAMETER;
730 if (kidstr == NULL) {
731 DEBUG(0, ("ERROR: Out of memory!\n"));
732 ret = NT_STATUS_NO_MEMORY;
736 if (!(ksidstr = sid_string_talloc(ctx, map->sid))) {
737 DEBUG(0, ("Out of memory!\n"));
738 ret = NT_STATUS_NO_MEMORY;
742 DEBUG(10, ("Storing %s <-> %s map\n", ksidstr, kidstr));
744 res = idmap_tdb2->transaction_start(idmap_tdb2);
746 DEBUG(1,(__location__ " Failed to start transaction\n"));
747 ret = NT_STATUS_UNSUCCESSFUL;
751 started_transaction = true;
753 /* check wheter sid mapping is already present in db */
754 data = dbwrap_fetch_bystring(idmap_tdb2, ksidstr, ksidstr);
756 ret = NT_STATUS_OBJECT_NAME_COLLISION;
760 ret = dbwrap_store_bystring(idmap_tdb2, ksidstr, string_term_tdb_data(kidstr),
762 if (!NT_STATUS_IS_OK(ret)) {
763 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
766 ret = dbwrap_store_bystring(idmap_tdb2, kidstr, string_term_tdb_data(ksidstr),
768 if (!NT_STATUS_IS_OK(ret)) {
769 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
770 /* try to remove the previous stored SID -> ID map */
771 dbwrap_delete_bystring(idmap_tdb2, ksidstr);
775 started_transaction = false;
777 res = idmap_tdb2->transaction_commit(idmap_tdb2);
779 DEBUG(1,(__location__ " Failed to commit transaction\n"));
780 ret = NT_STATUS_UNSUCCESSFUL;
784 DEBUG(10,("Stored %s <-> %s\n", ksidstr, kidstr));
788 if (started_transaction) {
789 idmap_tdb2->transaction_cancel(idmap_tdb2);
791 talloc_free(ksidstr);
799 static NTSTATUS idmap_tdb2_remove_mapping(struct idmap_domain *dom, const struct id_map *map)
801 /* not supported as it would invalidate the cache tdb on other
803 DEBUG(0,("idmap_tdb2_remove_mapping not supported\n"));
804 return NT_STATUS_NOT_SUPPORTED;
808 Close the idmap tdb instance
810 static NTSTATUS idmap_tdb2_close(struct idmap_domain *dom)
812 /* don't do anything */
818 Dump all mappings out
820 static NTSTATUS idmap_tdb2_dump_data(struct idmap_domain *dom, struct id_map **maps, int *num_maps)
822 DEBUG(0,("idmap_tdb2_dump_data not supported\n"));
823 return NT_STATUS_NOT_SUPPORTED;
826 static struct idmap_methods db_methods = {
827 .init = idmap_tdb2_db_init,
828 .unixids_to_sids = idmap_tdb2_unixids_to_sids,
829 .sids_to_unixids = idmap_tdb2_sids_to_unixids,
830 .set_mapping = idmap_tdb2_set_mapping,
831 .remove_mapping = idmap_tdb2_remove_mapping,
832 .dump_data = idmap_tdb2_dump_data,
833 .close_fn = idmap_tdb2_close
836 static struct idmap_alloc_methods db_alloc_methods = {
837 .init = idmap_tdb2_alloc_init,
838 .allocate_id = idmap_tdb2_allocate_id,
839 .get_id_hwm = idmap_tdb2_get_hwm,
840 .set_id_hwm = idmap_tdb2_set_hwm,
841 .close_fn = idmap_tdb2_alloc_close
844 NTSTATUS idmap_tdb2_init(void)
848 /* register both backends */
849 ret = smb_register_idmap_alloc(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_alloc_methods);
850 if (! NT_STATUS_IS_OK(ret)) {
851 DEBUG(0, ("Unable to register idmap alloc tdb2 module: %s\n", get_friendly_nt_error_msg(ret)));
855 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_methods);