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
17 Copyright (C) Michael Adam 2009-2010
19 This program is free software; you can redistribute it and/or modify
20 it under the terms of the GNU General Public License as published by
21 the Free Software Foundation; either version 2 of the License, or
22 (at your option) any later version.
24 This program is distributed in the hope that it will be useful,
25 but WITHOUT ANY WARRANTY; without even the implied warranty of
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 GNU General Public License for more details.
29 You should have received a copy of the GNU General Public License
30 along with this program; if not, write to the Free Software
31 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
39 #include "../libcli/security/dom_sid.h"
42 #define DBGC_CLASS DBGC_IDMAP
44 struct idmap_tdb2_context {
45 struct db_context *db;
46 const char *script; /* script to provide idmaps */
47 struct idmap_rw_ops *rw_ops;
50 /* High water mark keys */
51 #define HWM_GROUP "GROUP HWM"
52 #define HWM_USER "USER HWM"
56 * check and initialize high/low water marks in the db
58 static NTSTATUS idmap_tdb2_init_hwm(struct idmap_domain *dom)
61 struct idmap_tdb2_context *ctx;
63 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
65 /* Create high water marks for group and user id */
67 low_id = dbwrap_fetch_int32(ctx->db, HWM_USER);
68 if ((low_id == -1) || (low_id < dom->low_id)) {
69 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
72 DEBUG(0, ("Unable to initialise user hwm in idmap "
74 return NT_STATUS_INTERNAL_DB_ERROR;
78 low_id = dbwrap_fetch_int32(ctx->db, HWM_GROUP);
79 if ((low_id == -1) || (low_id < dom->low_id)) {
80 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
83 DEBUG(0, ("Unable to initialise group hwm in idmap "
85 return NT_STATUS_INTERNAL_DB_ERROR;
94 open the permanent tdb
96 static NTSTATUS idmap_tdb2_open_db(struct idmap_domain *dom)
99 struct idmap_tdb2_context *ctx;
101 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
104 /* its already open */
108 db_path = lp_parm_talloc_string(-1, "tdb", "idmap2.tdb", NULL);
109 if (db_path == NULL) {
110 /* fall back to the private directory, which, despite
111 its name, is usually on shared storage */
112 db_path = talloc_asprintf(NULL, "%s/idmap2.tdb", lp_private_dir());
114 NT_STATUS_HAVE_NO_MEMORY(db_path);
116 /* Open idmap repository */
117 ctx->db = db_open(ctx, db_path, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0644);
118 TALLOC_FREE(db_path);
120 if (ctx->db == NULL) {
121 DEBUG(0, ("Unable to open idmap_tdb2 database '%s'\n",
123 return NT_STATUS_UNSUCCESSFUL;
126 return idmap_tdb2_init_hwm(dom);
134 struct idmap_tdb2_allocate_id_context {
141 static NTSTATUS idmap_tdb2_allocate_id_action(struct db_context *db,
145 struct idmap_tdb2_allocate_id_context *state;
148 state = (struct idmap_tdb2_allocate_id_context *)private_data;
150 hwm = dbwrap_fetch_int32(db, state->hwmkey);
152 ret = NT_STATUS_INTERNAL_DB_ERROR;
156 /* check it is in the range */
157 if (hwm > state->high_hwm) {
158 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
159 state->hwmtype, (unsigned long)state->high_hwm));
160 ret = NT_STATUS_UNSUCCESSFUL;
164 /* fetch a new id and increment it */
165 ret = dbwrap_trans_change_uint32_atomic(db, state->hwmkey, &hwm, 1);
166 if (!NT_STATUS_IS_OK(ret)) {
167 DEBUG(1, ("Fatal error while fetching a new %s value\n!",
172 /* recheck it is in the range */
173 if (hwm > state->high_hwm) {
174 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
175 state->hwmtype, (unsigned long)state->high_hwm));
176 ret = NT_STATUS_UNSUCCESSFUL;
187 static NTSTATUS idmap_tdb2_allocate_id(struct idmap_domain *dom,
195 struct idmap_tdb2_allocate_id_context state;
196 struct idmap_tdb2_context *ctx;
198 status = idmap_tdb2_open_db(dom);
199 NT_STATUS_NOT_OK_RETURN(status);
201 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
203 /* Get current high water mark */
217 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
218 return NT_STATUS_INVALID_PARAMETER;
221 high_hwm = dom->high_id;
224 state.high_hwm = high_hwm;
225 state.hwmtype = hwmtype;
226 state.hwmkey = hwmkey;
228 status = dbwrap_trans_do(ctx->db, idmap_tdb2_allocate_id_action,
231 if (NT_STATUS_IS_OK(status)) {
233 DEBUG(10,("New %s = %d\n", hwmtype, state.hwm));
235 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
242 * Allocate a new unix-ID.
243 * For now this is for the default idmap domain only.
244 * Should be extended later on.
246 static NTSTATUS idmap_tdb2_get_new_id(struct idmap_domain *dom,
251 if (!strequal(dom->name, "*")) {
252 DEBUG(3, ("idmap_tdb2_get_new_id: "
253 "Refusing creation of mapping for domain'%s'. "
254 "Currently only supported for the default "
257 return NT_STATUS_NOT_IMPLEMENTED;
260 ret = idmap_tdb2_allocate_id(dom, id);
266 IDMAP MAPPING TDB BACKEND
269 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom,
270 const struct id_map *map);
273 Initialise idmap database.
275 static NTSTATUS idmap_tdb2_db_init(struct idmap_domain *dom,
279 struct idmap_tdb2_context *ctx;
281 ctx = talloc_zero(dom, struct idmap_tdb2_context);
283 DEBUG(0, ("Out of memory!\n"));
284 return NT_STATUS_NO_MEMORY;
287 if (strequal(dom->name, "*")) {
288 ctx->script = lp_parm_const_string(-1, "idmap", "script", NULL);
290 DEBUG(1, ("using idmap script '%s'\n", ctx->script));
293 char *config_option = NULL;
295 config_option = talloc_asprintf(ctx, "idmap config %s", dom->name);
296 if ( ! config_option) {
297 DEBUG(0, ("Out of memory!\n"));
298 ret = NT_STATUS_NO_MEMORY;
302 ctx->script = lp_parm_const_string(-1, config_option, "script", NULL);
304 DEBUG(1, ("using idmap script '%s'\n", ctx->script));
307 talloc_free(config_option);
310 ctx->rw_ops = talloc_zero(ctx, struct idmap_rw_ops);
311 if (ctx->rw_ops == NULL) {
312 DEBUG(0, ("Out of memory!\n"));
313 ret = NT_STATUS_NO_MEMORY;
317 ctx->rw_ops->get_new_id = idmap_tdb2_get_new_id;
318 ctx->rw_ops->set_mapping = idmap_tdb2_set_mapping;
320 dom->private_data = ctx;
322 ret = idmap_tdb2_open_db(dom);
323 if (!NT_STATUS_IS_OK(ret)) {
336 * store a mapping in the database.
339 struct idmap_tdb2_set_mapping_context {
344 static NTSTATUS idmap_tdb2_set_mapping_action(struct db_context *db,
349 struct idmap_tdb2_set_mapping_context *state;
350 TALLOC_CTX *tmp_ctx = talloc_stackframe();
352 state = (struct idmap_tdb2_set_mapping_context *)private_data;
354 DEBUG(10, ("Storing %s <-> %s map\n", state->ksidstr, state->kidstr));
356 /* check wheter sid mapping is already present in db */
357 data = dbwrap_fetch_bystring(db, tmp_ctx, state->ksidstr);
359 ret = NT_STATUS_OBJECT_NAME_COLLISION;
363 ret = dbwrap_store_bystring(db, state->ksidstr,
364 string_term_tdb_data(state->kidstr),
366 if (!NT_STATUS_IS_OK(ret)) {
367 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
371 ret = dbwrap_store_bystring(db, state->kidstr,
372 string_term_tdb_data(state->ksidstr),
374 if (!NT_STATUS_IS_OK(ret)) {
375 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
376 /* try to remove the previous stored SID -> ID map */
377 dbwrap_delete_bystring(db, state->ksidstr);
381 DEBUG(10,("Stored %s <-> %s\n", state->ksidstr, state->kidstr));
384 talloc_free(tmp_ctx);
388 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom, const struct id_map *map)
390 struct idmap_tdb2_context *ctx;
392 char *ksidstr, *kidstr;
393 struct idmap_tdb2_set_mapping_context state;
395 if (!map || !map->sid) {
396 return NT_STATUS_INVALID_PARAMETER;
399 ksidstr = kidstr = NULL;
401 /* TODO: should we filter a set_mapping using low/high filters ? */
403 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
405 switch (map->xid.type) {
408 kidstr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
412 kidstr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
416 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
417 return NT_STATUS_INVALID_PARAMETER;
420 if (kidstr == NULL) {
421 DEBUG(0, ("ERROR: Out of memory!\n"));
422 ret = NT_STATUS_NO_MEMORY;
426 ksidstr = sid_string_talloc(ctx, map->sid);
427 if (ksidstr == NULL) {
428 DEBUG(0, ("Out of memory!\n"));
429 ret = NT_STATUS_NO_MEMORY;
433 state.ksidstr = ksidstr;
434 state.kidstr = kidstr;
436 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
440 talloc_free(ksidstr);
446 * Create a new mapping for an unmapped SID, also allocating a new ID.
447 * This should be run inside a transaction.
450 * Properly integrate this with multi domain idmap config:
451 * Currently, the allocator is default-config only.
453 static NTSTATUS idmap_tdb2_new_mapping(struct idmap_domain *dom, struct id_map *map)
456 struct idmap_tdb2_context *ctx;
458 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
460 ret = idmap_rw_new_mapping(dom, ctx->rw_ops, map);
467 run a script to perform a mapping
469 The script should the following command lines:
475 and should return one of the following as a single line of text
481 static NTSTATUS idmap_tdb2_script(struct idmap_tdb2_context *ctx, struct id_map *map,
482 const char *fmt, ...)
490 cmd = talloc_asprintf(ctx, "%s ", ctx->script);
491 NT_STATUS_HAVE_NO_MEMORY(cmd);
494 cmd = talloc_vasprintf_append(cmd, fmt, ap);
496 NT_STATUS_HAVE_NO_MEMORY(cmd);
501 return NT_STATUS_NONE_MAPPED;
504 if (fgets(line, sizeof(line)-1, p) == NULL) {
506 return NT_STATUS_NONE_MAPPED;
510 DEBUG(10,("idmap script gave: %s\n", line));
512 if (sscanf(line, "UID:%lu", &v) == 1) {
514 map->xid.type = ID_TYPE_UID;
515 } else if (sscanf(line, "GID:%lu", &v) == 1) {
517 map->xid.type = ID_TYPE_GID;
518 } else if (strncmp(line, "SID:S-", 6) == 0) {
519 if (!string_to_sid(map->sid, &line[4])) {
520 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
522 return NT_STATUS_NONE_MAPPED;
525 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
527 return NT_STATUS_NONE_MAPPED;
536 Single id to sid lookup function.
538 static NTSTATUS idmap_tdb2_id_to_sid(struct idmap_domain *dom, struct id_map *map)
544 struct idmap_tdb2_context *ctx;
548 return NT_STATUS_INVALID_PARAMETER;
551 status = idmap_tdb2_open_db(dom);
552 NT_STATUS_NOT_OK_RETURN(status);
554 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
556 /* apply filters before checking */
557 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
558 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
559 map->xid.id, dom->low_id, dom->high_id));
560 return NT_STATUS_NONE_MAPPED;
563 switch (map->xid.type) {
566 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
570 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
574 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
575 return NT_STATUS_INVALID_PARAMETER;
578 /* final SAFE_FREE safe */
581 if (keystr == NULL) {
582 DEBUG(0, ("Out of memory!\n"));
583 ret = NT_STATUS_NO_MEMORY;
587 DEBUG(10,("Fetching record %s\n", keystr));
589 /* Check if the mapping exists */
590 data = dbwrap_fetch_bystring(ctx->db, keystr, keystr);
594 struct idmap_tdb2_set_mapping_context store_state;
596 DEBUG(10,("Record %s not found\n", keystr));
597 if (ctx->script == NULL) {
598 ret = NT_STATUS_NONE_MAPPED;
602 ret = idmap_tdb2_script(ctx, map, "IDTOSID %s", keystr);
604 /* store it on shared storage */
605 if (!NT_STATUS_IS_OK(ret)) {
609 sidstr = sid_string_talloc(keystr, map->sid);
611 ret = NT_STATUS_NO_MEMORY;
615 store_state.ksidstr = sidstr;
616 store_state.kidstr = keystr;
618 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
623 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
624 DEBUG(10,("INVALID SID (%s) in record %s\n",
625 (const char *)data.dptr, keystr));
626 ret = NT_STATUS_INTERNAL_DB_ERROR;
630 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
640 Single sid to id lookup function.
642 static NTSTATUS idmap_tdb2_sid_to_id(struct idmap_domain *dom, struct id_map *map)
647 unsigned long rec_id = 0;
648 struct idmap_tdb2_context *ctx;
649 TALLOC_CTX *tmp_ctx = talloc_stackframe();
651 ret = idmap_tdb2_open_db(dom);
652 NT_STATUS_NOT_OK_RETURN(ret);
654 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
656 keystr = sid_string_talloc(tmp_ctx, map->sid);
657 if (keystr == NULL) {
658 DEBUG(0, ("Out of memory!\n"));
659 ret = NT_STATUS_NO_MEMORY;
663 DEBUG(10,("Fetching record %s\n", keystr));
665 /* Check if sid is present in database */
666 data = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr);
669 struct idmap_tdb2_set_mapping_context store_state;
671 DEBUG(10,(__location__ " Record %s not found\n", keystr));
673 if (ctx->script == NULL) {
674 ret = NT_STATUS_NONE_MAPPED;
678 ret = idmap_tdb2_script(ctx, map, "SIDTOID %s", keystr);
679 /* store it on shared storage */
680 if (!NT_STATUS_IS_OK(ret)) {
684 /* apply filters before returning result */
685 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
686 DEBUG(5, ("Script returned id (%u) out of range "
687 "(%u - %u). Filtered!\n",
688 map->xid.id, dom->low_id, dom->high_id));
689 ret = NT_STATUS_NONE_MAPPED;
693 idstr = talloc_asprintf(tmp_ctx, "%cID %lu",
694 map->xid.type == ID_TYPE_UID?'U':'G',
695 (unsigned long)map->xid.id);
697 ret = NT_STATUS_NO_MEMORY;
701 store_state.ksidstr = keystr;
702 store_state.kidstr = idstr;
704 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
709 /* What type of record is this ? */
710 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
711 map->xid.id = rec_id;
712 map->xid.type = ID_TYPE_UID;
713 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
716 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
717 map->xid.id = rec_id;
718 map->xid.type = ID_TYPE_GID;
719 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
722 } else { /* Unknown record type ! */
723 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
724 ret = NT_STATUS_INTERNAL_DB_ERROR;
728 /* apply filters before returning result */
729 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
730 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
731 map->xid.id, dom->low_id, dom->high_id));
732 ret = NT_STATUS_NONE_MAPPED;
736 talloc_free(tmp_ctx);
741 lookup a set of unix ids.
743 static NTSTATUS idmap_tdb2_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
748 /* initialize the status to avoid suprise */
749 for (i = 0; ids[i]; i++) {
750 ids[i]->status = ID_UNKNOWN;
753 for (i = 0; ids[i]; i++) {
754 ret = idmap_tdb2_id_to_sid(dom, ids[i]);
755 if ( ! NT_STATUS_IS_OK(ret)) {
757 /* if it is just a failed mapping continue */
758 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
760 /* make sure it is marked as unmapped */
761 ids[i]->status = ID_UNMAPPED;
765 /* some fatal error occurred, return immediately */
769 /* all ok, id is mapped */
770 ids[i]->status = ID_MAPPED;
780 lookup a set of sids.
783 struct idmap_tdb2_sids_to_unixids_context {
784 struct idmap_domain *dom;
786 bool allocate_unmapped;
789 static NTSTATUS idmap_tdb2_sids_to_unixids_action(struct db_context *db,
792 struct idmap_tdb2_sids_to_unixids_context *state;
794 NTSTATUS ret = NT_STATUS_OK;
796 state = (struct idmap_tdb2_sids_to_unixids_context *)private_data;
798 DEBUG(10, ("idmap_tdb2_sids_to_unixids_action: "
799 " domain: [%s], allocate: %s\n",
801 state->allocate_unmapped ? "yes" : "no"));
803 for (i = 0; state->ids[i]; i++) {
804 if ((state->ids[i]->status == ID_UNKNOWN) ||
805 /* retry if we could not map in previous run: */
806 (state->ids[i]->status == ID_UNMAPPED))
810 ret2 = idmap_tdb2_sid_to_id(state->dom, state->ids[i]);
811 if (!NT_STATUS_IS_OK(ret2)) {
813 /* if it is just a failed mapping, continue */
814 if (NT_STATUS_EQUAL(ret2, NT_STATUS_NONE_MAPPED)) {
816 /* make sure it is marked as unmapped */
817 state->ids[i]->status = ID_UNMAPPED;
818 ret = STATUS_SOME_UNMAPPED;
820 /* some fatal error occurred, return immediately */
825 /* all ok, id is mapped */
826 state->ids[i]->status = ID_MAPPED;
830 if ((state->ids[i]->status == ID_UNMAPPED) &&
831 state->allocate_unmapped)
833 ret = idmap_tdb2_new_mapping(state->dom, state->ids[i]);
834 if (!NT_STATUS_IS_OK(ret)) {
844 static NTSTATUS idmap_tdb2_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
848 struct idmap_tdb2_sids_to_unixids_context state;
849 struct idmap_tdb2_context *ctx;
851 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
853 /* initialize the status to avoid suprise */
854 for (i = 0; ids[i]; i++) {
855 ids[i]->status = ID_UNKNOWN;
860 state.allocate_unmapped = false;
862 ret = idmap_tdb2_sids_to_unixids_action(ctx->db, &state);
864 if (NT_STATUS_EQUAL(ret, STATUS_SOME_UNMAPPED) && !dom->read_only) {
865 state.allocate_unmapped = true;
866 ret = dbwrap_trans_do(ctx->db,
867 idmap_tdb2_sids_to_unixids_action,
875 static struct idmap_methods db_methods = {
876 .init = idmap_tdb2_db_init,
877 .unixids_to_sids = idmap_tdb2_unixids_to_sids,
878 .sids_to_unixids = idmap_tdb2_sids_to_unixids,
879 .allocate_id = idmap_tdb2_get_new_id
882 NTSTATUS idmap_tdb2_init(void)
884 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_methods);