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 /* Create high water marks for group and user id */
115 if (!lp_idmap_uid(&low_uid, &high_uid)
116 || !lp_idmap_gid(&low_gid, &high_gid)) {
117 DEBUG(1, ("idmap uid or idmap gid missing\n"));
118 return NT_STATUS_UNSUCCESSFUL;
121 idmap_tdb2_state.low_uid = low_uid;
122 idmap_tdb2_state.high_uid = high_uid;
123 idmap_tdb2_state.low_gid = low_gid;
124 idmap_tdb2_state.high_gid = high_gid;
126 if (idmap_tdb2_state.high_uid <= idmap_tdb2_state.low_uid) {
127 DEBUG(1, ("idmap uid range missing or invalid\n"));
128 DEBUGADD(1, ("idmap will be unable to map foreign SIDs\n"));
129 return NT_STATUS_UNSUCCESSFUL;
132 if (((low_id = dbwrap_fetch_int32(idmap_tdb2,
134 (low_id < idmap_tdb2_state.low_uid)) {
135 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
136 idmap_tdb2, HWM_USER,
137 idmap_tdb2_state.low_uid))) {
138 DEBUG(0, ("Unable to initialise user hwm in idmap "
140 return NT_STATUS_INTERNAL_DB_ERROR;
144 if (idmap_tdb2_state.high_gid <= idmap_tdb2_state.low_gid) {
145 DEBUG(1, ("idmap gid range missing or invalid\n"));
146 DEBUGADD(1, ("idmap will be unable to map foreign SIDs\n"));
147 return NT_STATUS_UNSUCCESSFUL;
150 if (((low_id = dbwrap_fetch_int32(idmap_tdb2,
151 HWM_GROUP)) == -1) ||
152 (low_id < idmap_tdb2_state.low_gid)) {
153 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
154 idmap_tdb2, HWM_GROUP,
155 idmap_tdb2_state.low_gid))) {
156 DEBUG(0, ("Unable to initialise group hwm in idmap "
158 return NT_STATUS_INTERNAL_DB_ERROR;
167 Initialise idmap alloc database.
169 static NTSTATUS idmap_tdb2_alloc_init(const char *params)
171 /* nothing to do - we want to avoid opening the permanent
172 database if possible. Instead we load the params when we
181 static NTSTATUS idmap_tdb2_allocate_id(struct unixid *xid)
191 status = idmap_tdb2_open_db();
192 NT_STATUS_NOT_OK_RETURN(status);
194 /* Get current high water mark */
200 high_hwm = idmap_tdb2_state.high_uid;
206 high_hwm = idmap_tdb2_state.high_gid;
210 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
211 return NT_STATUS_INVALID_PARAMETER;
214 res = idmap_tdb2->transaction_start(idmap_tdb2);
216 DEBUG(1,(__location__ " Failed to start transaction\n"));
217 return NT_STATUS_UNSUCCESSFUL;
220 if ((hwm = dbwrap_fetch_int32(idmap_tdb2, hwmkey)) == -1) {
221 idmap_tdb2->transaction_cancel(idmap_tdb2);
222 return NT_STATUS_INTERNAL_DB_ERROR;
225 /* check it is in the range */
226 if (hwm > high_hwm) {
227 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
228 hwmtype, (unsigned long)high_hwm));
229 idmap_tdb2->transaction_cancel(idmap_tdb2);
230 return NT_STATUS_UNSUCCESSFUL;
233 /* fetch a new id and increment it */
234 ret = dbwrap_change_uint32_atomic(idmap_tdb2, hwmkey, &hwm, 1);
236 DEBUG(1, ("Fatal error while fetching a new %s value\n!", hwmtype));
237 idmap_tdb2->transaction_cancel(idmap_tdb2);
238 return NT_STATUS_UNSUCCESSFUL;
241 /* recheck it is in the range */
242 if (hwm > high_hwm) {
243 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
244 hwmtype, (unsigned long)high_hwm));
245 idmap_tdb2->transaction_cancel(idmap_tdb2);
246 return NT_STATUS_UNSUCCESSFUL;
249 res = idmap_tdb2->transaction_commit(idmap_tdb2);
251 DEBUG(1,(__location__ " Failed to commit transaction\n"));
252 return NT_STATUS_UNSUCCESSFUL;
256 DEBUG(10,("New %s = %d\n", hwmtype, hwm));
262 Get current highest id.
264 static NTSTATUS idmap_tdb2_get_hwm(struct unixid *xid)
272 status = idmap_tdb2_open_db();
273 NT_STATUS_NOT_OK_RETURN(status);
275 /* Get current high water mark */
281 high_hwm = idmap_tdb2_state.high_uid;
287 high_hwm = idmap_tdb2_state.high_gid;
291 return NT_STATUS_INVALID_PARAMETER;
294 if ((hwm = dbwrap_fetch_int32(idmap_tdb2, hwmkey)) == -1) {
295 return NT_STATUS_INTERNAL_DB_ERROR;
300 /* Warn if it is out of range */
301 if (hwm >= high_hwm) {
302 DEBUG(0, ("Warning: %s range full!! (max: %lu)\n",
303 hwmtype, (unsigned long)high_hwm));
312 static NTSTATUS idmap_tdb2_set_hwm(struct unixid *xid)
314 /* not supported, or we would invalidate the cache tdb on
316 DEBUG(0,("idmap_tdb2_set_hwm not supported\n"));
317 return NT_STATUS_NOT_SUPPORTED;
323 static NTSTATUS idmap_tdb2_alloc_close(void)
325 /* don't actually close it */
330 IDMAP MAPPING TDB BACKEND
332 struct idmap_tdb2_context {
333 uint32_t filter_low_id;
334 uint32_t filter_high_id;
338 Initialise idmap database.
340 static NTSTATUS idmap_tdb2_db_init(struct idmap_domain *dom,
344 struct idmap_tdb2_context *ctx;
345 char *config_option = NULL;
349 status = idmap_tdb2_open_db();
350 NT_STATUS_NOT_OK_RETURN(status);
352 ctx = talloc(dom, struct idmap_tdb2_context);
354 DEBUG(0, ("Out of memory!\n"));
355 return NT_STATUS_NO_MEMORY;
358 config_option = talloc_asprintf(ctx, "idmap config %s", dom->name);
359 if ( ! config_option) {
360 DEBUG(0, ("Out of memory!\n"));
361 ret = NT_STATUS_NO_MEMORY;
365 range = lp_parm_const_string(-1, config_option, "range", NULL);
367 (sscanf(range, "%u - %u", &ctx->filter_low_id, &ctx->filter_high_id) != 2) ||
368 (ctx->filter_low_id > ctx->filter_high_id)) {
369 ctx->filter_low_id = 0;
370 ctx->filter_high_id = 0;
373 dom->private_data = ctx;
375 talloc_free(config_option);
385 run a script to perform a mapping
387 The script should the following command lines:
393 and should return one of the following as a single line of text
399 static NTSTATUS idmap_tdb2_script(struct idmap_tdb2_context *ctx, struct id_map *map,
400 const char *fmt, ...)
408 cmd = talloc_asprintf(ctx, "%s ", idmap_tdb2_state.idmap_script);
409 NT_STATUS_HAVE_NO_MEMORY(cmd);
412 cmd = talloc_vasprintf_append(cmd, fmt, ap);
414 NT_STATUS_HAVE_NO_MEMORY(cmd);
419 return NT_STATUS_NONE_MAPPED;
422 if (fgets(line, sizeof(line)-1, p) == NULL) {
424 return NT_STATUS_NONE_MAPPED;
428 DEBUG(10,("idmap script gave: %s\n", line));
430 if (sscanf(line, "UID:%lu", &v) == 1) {
432 map->xid.type = ID_TYPE_UID;
433 } else if (sscanf(line, "GID:%lu", &v) == 1) {
435 map->xid.type = ID_TYPE_GID;
436 } else if (strncmp(line, "SID:S-", 6) == 0) {
437 if (!string_to_sid(map->sid, &line[4])) {
438 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
439 line, idmap_tdb2_state.idmap_script));
440 return NT_STATUS_NONE_MAPPED;
443 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
444 line, idmap_tdb2_state.idmap_script));
445 return NT_STATUS_NONE_MAPPED;
454 Single id to sid lookup function.
456 static NTSTATUS idmap_tdb2_id_to_sid(struct idmap_tdb2_context *ctx, struct id_map *map)
463 status = idmap_tdb2_open_db();
464 NT_STATUS_NOT_OK_RETURN(status);
467 return NT_STATUS_INVALID_PARAMETER;
470 /* apply filters before checking */
471 if ((ctx->filter_low_id && (map->xid.id < ctx->filter_low_id)) ||
472 (ctx->filter_high_id && (map->xid.id > ctx->filter_high_id))) {
473 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
474 map->xid.id, ctx->filter_low_id, ctx->filter_high_id));
475 return NT_STATUS_NONE_MAPPED;
478 switch (map->xid.type) {
481 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
485 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
489 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
490 return NT_STATUS_INVALID_PARAMETER;
493 /* final SAFE_FREE safe */
496 if (keystr == NULL) {
497 DEBUG(0, ("Out of memory!\n"));
498 ret = NT_STATUS_NO_MEMORY;
502 DEBUG(10,("Fetching record %s\n", keystr));
504 /* Check if the mapping exists */
505 data = dbwrap_fetch_bystring(idmap_tdb2, keystr, keystr);
510 DEBUG(10,("Record %s not found\n", keystr));
511 if (idmap_tdb2_state.idmap_script == NULL) {
512 ret = NT_STATUS_NONE_MAPPED;
516 ret = idmap_tdb2_script(ctx, map, "IDTOSID %s", keystr);
518 /* store it on shared storage */
519 if (!NT_STATUS_IS_OK(ret)) {
523 if (sid_to_fstring(sidstr, map->sid)) {
524 /* both forward and reverse mappings */
525 dbwrap_store_bystring(idmap_tdb2, keystr,
526 string_term_tdb_data(sidstr),
528 dbwrap_store_bystring(idmap_tdb2, sidstr,
529 string_term_tdb_data(keystr),
535 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
536 DEBUG(10,("INVALID SID (%s) in record %s\n",
537 (const char *)data.dptr, keystr));
538 ret = NT_STATUS_INTERNAL_DB_ERROR;
542 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
552 Single sid to id lookup function.
554 static NTSTATUS idmap_tdb2_sid_to_id(struct idmap_tdb2_context *ctx, struct id_map *map)
559 unsigned long rec_id = 0;
562 status = idmap_tdb2_open_db();
563 NT_STATUS_NOT_OK_RETURN(status);
565 if ((keystr = sid_string_talloc(ctx, map->sid)) == NULL) {
566 DEBUG(0, ("Out of memory!\n"));
567 ret = NT_STATUS_NO_MEMORY;
571 DEBUG(10,("Fetching record %s\n", keystr));
573 /* Check if sid is present in database */
574 data = dbwrap_fetch_bystring(idmap_tdb2, keystr, keystr);
578 DEBUG(10,(__location__ " Record %s not found\n", keystr));
580 if (idmap_tdb2_state.idmap_script == NULL) {
581 ret = NT_STATUS_NONE_MAPPED;
585 ret = idmap_tdb2_script(ctx, map, "SIDTOID %s", keystr);
586 /* store it on shared storage */
587 if (!NT_STATUS_IS_OK(ret)) {
591 snprintf(idstr, sizeof(idstr), "%cID %lu",
592 map->xid.type == ID_TYPE_UID?'U':'G',
593 (unsigned long)map->xid.id);
594 /* store both forward and reverse mappings */
595 dbwrap_store_bystring(idmap_tdb2, keystr, string_term_tdb_data(idstr),
597 dbwrap_store_bystring(idmap_tdb2, idstr, string_term_tdb_data(keystr),
602 /* What type of record is this ? */
603 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
604 map->xid.id = rec_id;
605 map->xid.type = ID_TYPE_UID;
606 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
609 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
610 map->xid.id = rec_id;
611 map->xid.type = ID_TYPE_GID;
612 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
615 } else { /* Unknown record type ! */
616 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
617 ret = NT_STATUS_INTERNAL_DB_ERROR;
620 /* apply filters before returning result */
621 if ((ctx->filter_low_id && (map->xid.id < ctx->filter_low_id)) ||
622 (ctx->filter_high_id && (map->xid.id > ctx->filter_high_id))) {
623 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
624 map->xid.id, ctx->filter_low_id, ctx->filter_high_id));
625 ret = NT_STATUS_NONE_MAPPED;
634 lookup a set of unix ids.
636 static NTSTATUS idmap_tdb2_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
638 struct idmap_tdb2_context *ctx;
642 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
644 for (i = 0; ids[i]; i++) {
645 ret = idmap_tdb2_id_to_sid(ctx, ids[i]);
646 if ( ! NT_STATUS_IS_OK(ret)) {
648 /* if it is just a failed mapping continue */
649 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
651 /* make sure it is marked as unmapped */
652 ids[i]->status = ID_UNMAPPED;
656 /* some fatal error occurred, return immediately */
660 /* all ok, id is mapped */
661 ids[i]->status = ID_MAPPED;
671 lookup a set of sids.
673 static NTSTATUS idmap_tdb2_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
675 struct idmap_tdb2_context *ctx;
679 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
681 for (i = 0; ids[i]; i++) {
682 ret = idmap_tdb2_sid_to_id(ctx, ids[i]);
683 if ( ! NT_STATUS_IS_OK(ret)) {
685 /* if it is just a failed mapping continue */
686 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
688 /* make sure it is marked as unmapped */
689 ids[i]->status = ID_UNMAPPED;
693 /* some fatal error occurred, return immediately */
697 /* all ok, id is mapped */
698 ids[i]->status = ID_MAPPED;
711 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom, const struct id_map *map)
713 struct idmap_tdb2_context *ctx;
716 char *ksidstr, *kidstr;
718 bool started_transaction = false;
720 if (!map || !map->sid) {
721 return NT_STATUS_INVALID_PARAMETER;
724 ksidstr = kidstr = NULL;
726 /* TODO: should we filter a set_mapping using low/high filters ? */
728 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
730 switch (map->xid.type) {
733 kidstr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
737 kidstr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
741 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
742 return NT_STATUS_INVALID_PARAMETER;
745 if (kidstr == NULL) {
746 DEBUG(0, ("ERROR: Out of memory!\n"));
747 ret = NT_STATUS_NO_MEMORY;
751 if (!(ksidstr = sid_string_talloc(ctx, map->sid))) {
752 DEBUG(0, ("Out of memory!\n"));
753 ret = NT_STATUS_NO_MEMORY;
757 DEBUG(10, ("Storing %s <-> %s map\n", ksidstr, kidstr));
759 res = idmap_tdb2->transaction_start(idmap_tdb2);
761 DEBUG(1,(__location__ " Failed to start transaction\n"));
762 ret = NT_STATUS_UNSUCCESSFUL;
766 started_transaction = true;
768 /* check wheter sid mapping is already present in db */
769 data = dbwrap_fetch_bystring(idmap_tdb2, ksidstr, ksidstr);
771 ret = NT_STATUS_OBJECT_NAME_COLLISION;
775 ret = dbwrap_store_bystring(idmap_tdb2, ksidstr, string_term_tdb_data(kidstr),
777 if (!NT_STATUS_IS_OK(ret)) {
778 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
781 ret = dbwrap_store_bystring(idmap_tdb2, kidstr, string_term_tdb_data(ksidstr),
783 if (!NT_STATUS_IS_OK(ret)) {
784 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
785 /* try to remove the previous stored SID -> ID map */
786 dbwrap_delete_bystring(idmap_tdb2, ksidstr);
790 started_transaction = false;
792 res = idmap_tdb2->transaction_commit(idmap_tdb2);
794 DEBUG(1,(__location__ " Failed to commit transaction\n"));
795 ret = NT_STATUS_UNSUCCESSFUL;
799 DEBUG(10,("Stored %s <-> %s\n", ksidstr, kidstr));
803 if (started_transaction) {
804 idmap_tdb2->transaction_cancel(idmap_tdb2);
806 talloc_free(ksidstr);
814 static NTSTATUS idmap_tdb2_remove_mapping(struct idmap_domain *dom, const struct id_map *map)
816 /* not supported as it would invalidate the cache tdb on other
818 DEBUG(0,("idmap_tdb2_remove_mapping not supported\n"));
819 return NT_STATUS_NOT_SUPPORTED;
823 Close the idmap tdb instance
825 static NTSTATUS idmap_tdb2_close(struct idmap_domain *dom)
827 /* don't do anything */
833 Dump all mappings out
835 static NTSTATUS idmap_tdb2_dump_data(struct idmap_domain *dom, struct id_map **maps, int *num_maps)
837 DEBUG(0,("idmap_tdb2_dump_data not supported\n"));
838 return NT_STATUS_NOT_SUPPORTED;
841 static struct idmap_methods db_methods = {
842 .init = idmap_tdb2_db_init,
843 .unixids_to_sids = idmap_tdb2_unixids_to_sids,
844 .sids_to_unixids = idmap_tdb2_sids_to_unixids,
845 .set_mapping = idmap_tdb2_set_mapping,
846 .remove_mapping = idmap_tdb2_remove_mapping,
847 .dump_data = idmap_tdb2_dump_data,
848 .close_fn = idmap_tdb2_close
851 static struct idmap_alloc_methods db_alloc_methods = {
852 .init = idmap_tdb2_alloc_init,
853 .allocate_id = idmap_tdb2_allocate_id,
854 .get_id_hwm = idmap_tdb2_get_hwm,
855 .set_id_hwm = idmap_tdb2_set_hwm,
856 .close_fn = idmap_tdb2_alloc_close
859 NTSTATUS idmap_tdb2_init(void)
863 /* register both backends */
864 ret = smb_register_idmap_alloc(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_alloc_methods);
865 if (! NT_STATUS_IS_OK(ret)) {
866 DEBUG(0, ("Unable to register idmap alloc tdb2 module: %s\n", get_friendly_nt_error_msg(ret)));
870 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_methods);