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)
103 /* see if a idmap script is configured */
104 idmap_tdb2_state.idmap_script = lp_parm_const_string(-1, "idmap",
107 if (idmap_tdb2_state.idmap_script) {
108 DEBUG(1, ("using idmap script '%s'\n",
109 idmap_tdb2_state.idmap_script));
114 if (!lp_idmap_uid(&low_uid, &high_uid)
115 || !lp_idmap_gid(&low_gid, &high_gid)) {
116 DEBUG(1, ("idmap uid or idmap gid missing\n"));
117 return NT_STATUS_UNSUCCESSFUL;
120 idmap_tdb2_state.low_uid = low_uid;
121 idmap_tdb2_state.high_uid = high_uid;
122 idmap_tdb2_state.low_gid = low_gid;
123 idmap_tdb2_state.high_gid = high_gid;
125 if (idmap_tdb2_state.high_uid <= idmap_tdb2_state.low_uid) {
126 DEBUG(1, ("idmap uid range missing or invalid\n"));
127 DEBUGADD(1, ("idmap will be unable to map foreign SIDs\n"));
128 return NT_STATUS_UNSUCCESSFUL;
131 if (idmap_tdb2_state.high_gid <= idmap_tdb2_state.low_gid) {
132 DEBUG(1, ("idmap gid range missing or invalid\n"));
133 DEBUGADD(1, ("idmap will be unable to map foreign SIDs\n"));
134 return NT_STATUS_UNSUCCESSFUL;
137 /* Create high water marks for group and user id */
139 if (((low_id = dbwrap_fetch_int32(idmap_tdb2,
141 (low_id < idmap_tdb2_state.low_uid)) {
142 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
143 idmap_tdb2, HWM_USER,
144 idmap_tdb2_state.low_uid))) {
145 DEBUG(0, ("Unable to initialise user hwm in idmap "
147 return NT_STATUS_INTERNAL_DB_ERROR;
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)
192 status = idmap_tdb2_open_db();
193 NT_STATUS_NOT_OK_RETURN(status);
195 /* Get current high water mark */
201 high_hwm = idmap_tdb2_state.high_uid;
207 high_hwm = idmap_tdb2_state.high_gid;
211 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
212 return NT_STATUS_INVALID_PARAMETER;
215 res = idmap_tdb2->transaction_start(idmap_tdb2);
217 DEBUG(1,(__location__ " Failed to start transaction\n"));
218 return NT_STATUS_UNSUCCESSFUL;
221 if ((hwm = dbwrap_fetch_int32(idmap_tdb2, hwmkey)) == -1) {
222 idmap_tdb2->transaction_cancel(idmap_tdb2);
223 return NT_STATUS_INTERNAL_DB_ERROR;
226 /* check it is in the range */
227 if (hwm > high_hwm) {
228 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
229 hwmtype, (unsigned long)high_hwm));
230 idmap_tdb2->transaction_cancel(idmap_tdb2);
231 return NT_STATUS_UNSUCCESSFUL;
234 /* fetch a new id and increment it */
235 ret = dbwrap_change_uint32_atomic(idmap_tdb2, hwmkey, &hwm, 1);
237 DEBUG(1, ("Fatal error while fetching a new %s value\n!", hwmtype));
238 idmap_tdb2->transaction_cancel(idmap_tdb2);
239 return NT_STATUS_UNSUCCESSFUL;
242 /* recheck it is in the range */
243 if (hwm > high_hwm) {
244 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
245 hwmtype, (unsigned long)high_hwm));
246 idmap_tdb2->transaction_cancel(idmap_tdb2);
247 return NT_STATUS_UNSUCCESSFUL;
250 res = idmap_tdb2->transaction_commit(idmap_tdb2);
252 DEBUG(1,(__location__ " Failed to commit transaction\n"));
253 return NT_STATUS_UNSUCCESSFUL;
257 DEBUG(10,("New %s = %d\n", hwmtype, hwm));
263 Get current highest id.
265 static NTSTATUS idmap_tdb2_get_hwm(struct unixid *xid)
273 status = idmap_tdb2_open_db();
274 NT_STATUS_NOT_OK_RETURN(status);
276 /* Get current high water mark */
282 high_hwm = idmap_tdb2_state.high_uid;
288 high_hwm = idmap_tdb2_state.high_gid;
292 return NT_STATUS_INVALID_PARAMETER;
295 if ((hwm = dbwrap_fetch_int32(idmap_tdb2, hwmkey)) == -1) {
296 return NT_STATUS_INTERNAL_DB_ERROR;
301 /* Warn if it is out of range */
302 if (hwm >= high_hwm) {
303 DEBUG(0, ("Warning: %s range full!! (max: %lu)\n",
304 hwmtype, (unsigned long)high_hwm));
313 static NTSTATUS idmap_tdb2_set_hwm(struct unixid *xid)
315 /* not supported, or we would invalidate the cache tdb on
317 DEBUG(0,("idmap_tdb2_set_hwm not supported\n"));
318 return NT_STATUS_NOT_SUPPORTED;
324 static NTSTATUS idmap_tdb2_alloc_close(void)
326 /* don't actually close it */
331 IDMAP MAPPING TDB BACKEND
333 struct idmap_tdb2_context {
334 uint32_t filter_low_id;
335 uint32_t filter_high_id;
339 Initialise idmap database.
341 static NTSTATUS idmap_tdb2_db_init(struct idmap_domain *dom,
345 struct idmap_tdb2_context *ctx;
346 char *config_option = NULL;
350 status = idmap_tdb2_open_db();
351 NT_STATUS_NOT_OK_RETURN(status);
353 ctx = talloc(dom, struct idmap_tdb2_context);
355 DEBUG(0, ("Out of memory!\n"));
356 return NT_STATUS_NO_MEMORY;
359 config_option = talloc_asprintf(ctx, "idmap config %s", dom->name);
360 if ( ! config_option) {
361 DEBUG(0, ("Out of memory!\n"));
362 ret = NT_STATUS_NO_MEMORY;
366 range = lp_parm_const_string(-1, config_option, "range", NULL);
368 (sscanf(range, "%u - %u", &ctx->filter_low_id, &ctx->filter_high_id) != 2) ||
369 (ctx->filter_low_id > ctx->filter_high_id)) {
370 ctx->filter_low_id = 0;
371 ctx->filter_high_id = 0;
374 dom->private_data = ctx;
376 talloc_free(config_option);
386 run a script to perform a mapping
388 The script should the following command lines:
394 and should return one of the following as a single line of text
400 static NTSTATUS idmap_tdb2_script(struct idmap_tdb2_context *ctx, struct id_map *map,
401 const char *fmt, ...)
409 cmd = talloc_asprintf(ctx, "%s ", idmap_tdb2_state.idmap_script);
410 NT_STATUS_HAVE_NO_MEMORY(cmd);
413 cmd = talloc_vasprintf_append(cmd, fmt, ap);
415 NT_STATUS_HAVE_NO_MEMORY(cmd);
420 return NT_STATUS_NONE_MAPPED;
423 if (fgets(line, sizeof(line)-1, p) == NULL) {
425 return NT_STATUS_NONE_MAPPED;
429 DEBUG(10,("idmap script gave: %s\n", line));
431 if (sscanf(line, "UID:%lu", &v) == 1) {
433 map->xid.type = ID_TYPE_UID;
434 } else if (sscanf(line, "GID:%lu", &v) == 1) {
436 map->xid.type = ID_TYPE_GID;
437 } else if (strncmp(line, "SID:S-", 6) == 0) {
438 if (!string_to_sid(map->sid, &line[4])) {
439 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
440 line, idmap_tdb2_state.idmap_script));
441 return NT_STATUS_NONE_MAPPED;
444 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
445 line, idmap_tdb2_state.idmap_script));
446 return NT_STATUS_NONE_MAPPED;
455 Single id to sid lookup function.
457 static NTSTATUS idmap_tdb2_id_to_sid(struct idmap_tdb2_context *ctx, struct id_map *map)
464 status = idmap_tdb2_open_db();
465 NT_STATUS_NOT_OK_RETURN(status);
468 return NT_STATUS_INVALID_PARAMETER;
471 /* apply filters before checking */
472 if ((ctx->filter_low_id && (map->xid.id < ctx->filter_low_id)) ||
473 (ctx->filter_high_id && (map->xid.id > ctx->filter_high_id))) {
474 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
475 map->xid.id, ctx->filter_low_id, ctx->filter_high_id));
476 return NT_STATUS_NONE_MAPPED;
479 switch (map->xid.type) {
482 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
486 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
490 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
491 return NT_STATUS_INVALID_PARAMETER;
494 /* final SAFE_FREE safe */
497 if (keystr == NULL) {
498 DEBUG(0, ("Out of memory!\n"));
499 ret = NT_STATUS_NO_MEMORY;
503 DEBUG(10,("Fetching record %s\n", keystr));
505 /* Check if the mapping exists */
506 data = dbwrap_fetch_bystring(idmap_tdb2, keystr, keystr);
511 DEBUG(10,("Record %s not found\n", keystr));
512 if (idmap_tdb2_state.idmap_script == NULL) {
513 ret = NT_STATUS_NONE_MAPPED;
517 ret = idmap_tdb2_script(ctx, map, "IDTOSID %s", keystr);
519 /* store it on shared storage */
520 if (!NT_STATUS_IS_OK(ret)) {
524 if (sid_to_fstring(sidstr, map->sid)) {
525 /* both forward and reverse mappings */
526 dbwrap_store_bystring(idmap_tdb2, keystr,
527 string_term_tdb_data(sidstr),
529 dbwrap_store_bystring(idmap_tdb2, sidstr,
530 string_term_tdb_data(keystr),
536 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
537 DEBUG(10,("INVALID SID (%s) in record %s\n",
538 (const char *)data.dptr, keystr));
539 ret = NT_STATUS_INTERNAL_DB_ERROR;
543 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
553 Single sid to id lookup function.
555 static NTSTATUS idmap_tdb2_sid_to_id(struct idmap_tdb2_context *ctx, struct id_map *map)
560 unsigned long rec_id = 0;
561 TALLOC_CTX *tmp_ctx = talloc_stackframe();
563 ret = idmap_tdb2_open_db();
564 NT_STATUS_NOT_OK_RETURN(ret);
566 keystr = sid_string_talloc(tmp_ctx, map->sid);
567 if (keystr == NULL) {
568 DEBUG(0, ("Out of memory!\n"));
569 ret = NT_STATUS_NO_MEMORY;
573 DEBUG(10,("Fetching record %s\n", keystr));
575 /* Check if sid is present in database */
576 data = dbwrap_fetch_bystring(idmap_tdb2, tmp_ctx, keystr);
580 DEBUG(10,(__location__ " Record %s not found\n", keystr));
582 if (idmap_tdb2_state.idmap_script == NULL) {
583 ret = NT_STATUS_NONE_MAPPED;
587 ret = idmap_tdb2_script(ctx, map, "SIDTOID %s", keystr);
588 /* store it on shared storage */
589 if (!NT_STATUS_IS_OK(ret)) {
593 snprintf(idstr, sizeof(idstr), "%cID %lu",
594 map->xid.type == ID_TYPE_UID?'U':'G',
595 (unsigned long)map->xid.id);
596 /* store both forward and reverse mappings */
597 dbwrap_store_bystring(idmap_tdb2, keystr, string_term_tdb_data(idstr),
599 dbwrap_store_bystring(idmap_tdb2, idstr, string_term_tdb_data(keystr),
604 /* What type of record is this ? */
605 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
606 map->xid.id = rec_id;
607 map->xid.type = ID_TYPE_UID;
608 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
611 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
612 map->xid.id = rec_id;
613 map->xid.type = ID_TYPE_GID;
614 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
617 } else { /* Unknown record type ! */
618 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
619 ret = NT_STATUS_INTERNAL_DB_ERROR;
622 /* apply filters before returning result */
623 if ((ctx->filter_low_id && (map->xid.id < ctx->filter_low_id)) ||
624 (ctx->filter_high_id && (map->xid.id > ctx->filter_high_id))) {
625 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
626 map->xid.id, ctx->filter_low_id, ctx->filter_high_id));
627 ret = NT_STATUS_NONE_MAPPED;
631 talloc_free(tmp_ctx);
636 lookup a set of unix ids.
638 static NTSTATUS idmap_tdb2_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
640 struct idmap_tdb2_context *ctx;
644 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
646 for (i = 0; ids[i]; i++) {
647 ret = idmap_tdb2_id_to_sid(ctx, ids[i]);
648 if ( ! NT_STATUS_IS_OK(ret)) {
650 /* if it is just a failed mapping continue */
651 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
653 /* make sure it is marked as unmapped */
654 ids[i]->status = ID_UNMAPPED;
658 /* some fatal error occurred, return immediately */
662 /* all ok, id is mapped */
663 ids[i]->status = ID_MAPPED;
673 lookup a set of sids.
675 static NTSTATUS idmap_tdb2_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
677 struct idmap_tdb2_context *ctx;
681 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
683 for (i = 0; ids[i]; i++) {
684 ret = idmap_tdb2_sid_to_id(ctx, ids[i]);
685 if ( ! NT_STATUS_IS_OK(ret)) {
687 /* if it is just a failed mapping continue */
688 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
690 /* make sure it is marked as unmapped */
691 ids[i]->status = ID_UNMAPPED;
695 /* some fatal error occurred, return immediately */
699 /* all ok, id is mapped */
700 ids[i]->status = ID_MAPPED;
713 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom, const struct id_map *map)
715 struct idmap_tdb2_context *ctx;
718 char *ksidstr, *kidstr;
720 bool started_transaction = false;
722 if (!map || !map->sid) {
723 return NT_STATUS_INVALID_PARAMETER;
726 ksidstr = kidstr = NULL;
728 /* TODO: should we filter a set_mapping using low/high filters ? */
730 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
732 switch (map->xid.type) {
735 kidstr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
739 kidstr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
743 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
744 return NT_STATUS_INVALID_PARAMETER;
747 if (kidstr == NULL) {
748 DEBUG(0, ("ERROR: Out of memory!\n"));
749 ret = NT_STATUS_NO_MEMORY;
753 if (!(ksidstr = sid_string_talloc(ctx, map->sid))) {
754 DEBUG(0, ("Out of memory!\n"));
755 ret = NT_STATUS_NO_MEMORY;
759 DEBUG(10, ("Storing %s <-> %s map\n", ksidstr, kidstr));
761 res = idmap_tdb2->transaction_start(idmap_tdb2);
763 DEBUG(1,(__location__ " Failed to start transaction\n"));
764 ret = NT_STATUS_UNSUCCESSFUL;
768 started_transaction = true;
770 /* check wheter sid mapping is already present in db */
771 data = dbwrap_fetch_bystring(idmap_tdb2, ksidstr, ksidstr);
773 ret = NT_STATUS_OBJECT_NAME_COLLISION;
777 ret = dbwrap_store_bystring(idmap_tdb2, ksidstr, string_term_tdb_data(kidstr),
779 if (!NT_STATUS_IS_OK(ret)) {
780 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
783 ret = dbwrap_store_bystring(idmap_tdb2, kidstr, string_term_tdb_data(ksidstr),
785 if (!NT_STATUS_IS_OK(ret)) {
786 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
787 /* try to remove the previous stored SID -> ID map */
788 dbwrap_delete_bystring(idmap_tdb2, ksidstr);
792 started_transaction = false;
794 res = idmap_tdb2->transaction_commit(idmap_tdb2);
796 DEBUG(1,(__location__ " Failed to commit transaction\n"));
797 ret = NT_STATUS_UNSUCCESSFUL;
801 DEBUG(10,("Stored %s <-> %s\n", ksidstr, kidstr));
805 if (started_transaction) {
806 idmap_tdb2->transaction_cancel(idmap_tdb2);
808 talloc_free(ksidstr);
816 static NTSTATUS idmap_tdb2_remove_mapping(struct idmap_domain *dom, const struct id_map *map)
818 /* not supported as it would invalidate the cache tdb on other
820 DEBUG(0,("idmap_tdb2_remove_mapping not supported\n"));
821 return NT_STATUS_NOT_SUPPORTED;
825 Close the idmap tdb instance
827 static NTSTATUS idmap_tdb2_close(struct idmap_domain *dom)
829 /* don't do anything */
835 Dump all mappings out
837 static NTSTATUS idmap_tdb2_dump_data(struct idmap_domain *dom, struct id_map **maps, int *num_maps)
839 DEBUG(0,("idmap_tdb2_dump_data not supported\n"));
840 return NT_STATUS_NOT_SUPPORTED;
843 static struct idmap_methods db_methods = {
844 .init = idmap_tdb2_db_init,
845 .unixids_to_sids = idmap_tdb2_unixids_to_sids,
846 .sids_to_unixids = idmap_tdb2_sids_to_unixids,
847 .set_mapping = idmap_tdb2_set_mapping,
848 .remove_mapping = idmap_tdb2_remove_mapping,
849 .dump_data = idmap_tdb2_dump_data,
850 .close_fn = idmap_tdb2_close
853 static struct idmap_alloc_methods db_alloc_methods = {
854 .init = idmap_tdb2_alloc_init,
855 .allocate_id = idmap_tdb2_allocate_id,
856 .get_id_hwm = idmap_tdb2_get_hwm,
857 .set_id_hwm = idmap_tdb2_set_hwm,
858 .close_fn = idmap_tdb2_alloc_close
861 NTSTATUS idmap_tdb2_init(void)
865 /* register both backends */
866 ret = smb_register_idmap_alloc(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_alloc_methods);
867 if (! NT_STATUS_IS_OK(ret)) {
868 DEBUG(0, ("Unable to register idmap alloc tdb2 module: %s\n", get_friendly_nt_error_msg(ret)));
872 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_methods);