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 #define DBGC_CLASS DBGC_IDMAP
41 struct idmap_tdb2_context {
42 struct db_context *db;
43 const char *script; /* script to provide idmaps */
44 struct idmap_rw_ops *rw_ops;
47 /* High water mark keys */
48 #define HWM_GROUP "GROUP HWM"
49 #define HWM_USER "USER HWM"
53 * check and initialize high/low water marks in the db
55 static NTSTATUS idmap_tdb2_init_hwm(struct idmap_domain *dom)
58 struct idmap_tdb2_context *ctx;
60 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
62 /* Create high water marks for group and user id */
64 low_id = dbwrap_fetch_int32(ctx->db, HWM_USER);
65 if ((low_id == -1) || (low_id < dom->low_id)) {
66 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
69 DEBUG(0, ("Unable to initialise user hwm in idmap "
71 return NT_STATUS_INTERNAL_DB_ERROR;
75 low_id = dbwrap_fetch_int32(ctx->db, HWM_GROUP);
76 if ((low_id == -1) || (low_id < dom->low_id)) {
77 if (!NT_STATUS_IS_OK(dbwrap_trans_store_int32(
80 DEBUG(0, ("Unable to initialise group hwm in idmap "
82 return NT_STATUS_INTERNAL_DB_ERROR;
91 open the permanent tdb
93 static NTSTATUS idmap_tdb2_open_db(struct idmap_domain *dom)
96 struct idmap_tdb2_context *ctx;
98 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
101 /* its already open */
105 db_path = lp_parm_talloc_string(-1, "tdb", "idmap2.tdb", NULL);
106 if (db_path == NULL) {
107 /* fall back to the private directory, which, despite
108 its name, is usually on shared storage */
109 db_path = talloc_asprintf(NULL, "%s/idmap2.tdb", lp_private_dir());
111 NT_STATUS_HAVE_NO_MEMORY(db_path);
113 /* Open idmap repository */
114 ctx->db = db_open(ctx, db_path, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0644);
115 TALLOC_FREE(db_path);
117 if (ctx->db == NULL) {
118 DEBUG(0, ("Unable to open idmap_tdb2 database '%s'\n",
120 return NT_STATUS_UNSUCCESSFUL;
123 return idmap_tdb2_init_hwm(dom);
131 struct idmap_tdb2_allocate_id_context {
138 static NTSTATUS idmap_tdb2_allocate_id_action(struct db_context *db,
142 struct idmap_tdb2_allocate_id_context *state;
145 state = (struct idmap_tdb2_allocate_id_context *)private_data;
147 hwm = dbwrap_fetch_int32(db, state->hwmkey);
149 ret = NT_STATUS_INTERNAL_DB_ERROR;
153 /* check it is in the range */
154 if (hwm > state->high_hwm) {
155 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
156 state->hwmtype, (unsigned long)state->high_hwm));
157 ret = NT_STATUS_UNSUCCESSFUL;
161 /* fetch a new id and increment it */
162 ret = dbwrap_trans_change_uint32_atomic(db, state->hwmkey, &hwm, 1);
163 if (!NT_STATUS_IS_OK(ret)) {
164 DEBUG(1, ("Fatal error while fetching a new %s value\n!",
169 /* recheck it is in the range */
170 if (hwm > state->high_hwm) {
171 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
172 state->hwmtype, (unsigned long)state->high_hwm));
173 ret = NT_STATUS_UNSUCCESSFUL;
184 static NTSTATUS idmap_tdb2_allocate_id(struct idmap_domain *dom,
192 struct idmap_tdb2_allocate_id_context state;
193 struct idmap_tdb2_context *ctx;
195 status = idmap_tdb2_open_db(dom);
196 NT_STATUS_NOT_OK_RETURN(status);
198 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
200 /* Get current high water mark */
214 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
215 return NT_STATUS_INVALID_PARAMETER;
218 high_hwm = dom->high_id;
221 state.high_hwm = high_hwm;
222 state.hwmtype = hwmtype;
223 state.hwmkey = hwmkey;
225 status = dbwrap_trans_do(ctx->db, idmap_tdb2_allocate_id_action,
228 if (NT_STATUS_IS_OK(status)) {
230 DEBUG(10,("New %s = %d\n", hwmtype, state.hwm));
232 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
239 * Allocate a new unix-ID.
240 * For now this is for the default idmap domain only.
241 * Should be extended later on.
243 static NTSTATUS idmap_tdb2_get_new_id(struct idmap_domain *dom,
248 if (!strequal(dom->name, "*")) {
249 DEBUG(3, ("idmap_tdb2_get_new_id: "
250 "Refusing creation of mapping for domain'%s'. "
251 "Currently only supported for the default "
254 return NT_STATUS_NOT_IMPLEMENTED;
257 ret = idmap_tdb2_allocate_id(dom, id);
263 IDMAP MAPPING TDB BACKEND
267 Initialise idmap database.
269 static NTSTATUS idmap_tdb2_db_init(struct idmap_domain *dom,
273 struct idmap_tdb2_context *ctx;
275 ctx = talloc_zero(dom, struct idmap_tdb2_context);
277 DEBUG(0, ("Out of memory!\n"));
278 return NT_STATUS_NO_MEMORY;
281 if (strequal(dom->name, "*")) {
282 ctx->script = lp_parm_const_string(-1, "idmap", "script", NULL);
284 DEBUG(1, ("using idmap script '%s'\n", ctx->script));
287 char *config_option = NULL;
289 config_option = talloc_asprintf(ctx, "idmap config %s", dom->name);
290 if ( ! config_option) {
291 DEBUG(0, ("Out of memory!\n"));
292 ret = NT_STATUS_NO_MEMORY;
296 ctx->script = lp_parm_const_string(-1, config_option, "script", NULL);
298 DEBUG(1, ("using idmap script '%s'\n", ctx->script));
301 talloc_free(config_option);
304 ctx->rw_ops = talloc_zero(ctx, struct idmap_rw_ops);
305 if (ctx->rw_ops == NULL) {
306 DEBUG(0, ("Out of memory!\n"));
307 ret = NT_STATUS_NO_MEMORY;
311 ctx->rw_ops->get_new_id = idmap_tdb2_get_new_id;
312 ctx->rw_ops->set_mapping = idmap_tdb2_set_mapping;
314 dom->private_data = ctx;
316 ret = idmap_tdb2_open_db(dom);
317 if (!NT_STATUS_IS_OK(ret)) {
330 * store a mapping in the database.
333 struct idmap_tdb2_set_mapping_context {
338 static NTSTATUS idmap_tdb2_set_mapping_action(struct db_context *db,
343 struct idmap_tdb2_set_mapping_context *state;
344 TALLOC_CTX *tmp_ctx = talloc_stackframe();
346 state = (struct idmap_tdb2_set_mapping_context *)private_data;
348 DEBUG(10, ("Storing %s <-> %s map\n", state->ksidstr, state->kidstr));
350 /* check wheter sid mapping is already present in db */
351 data = dbwrap_fetch_bystring(db, tmp_ctx, state->ksidstr);
353 ret = NT_STATUS_OBJECT_NAME_COLLISION;
357 ret = dbwrap_store_bystring(db, state->ksidstr,
358 string_term_tdb_data(state->kidstr),
360 if (!NT_STATUS_IS_OK(ret)) {
361 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
365 ret = dbwrap_store_bystring(db, state->kidstr,
366 string_term_tdb_data(state->ksidstr),
368 if (!NT_STATUS_IS_OK(ret)) {
369 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
370 /* try to remove the previous stored SID -> ID map */
371 dbwrap_delete_bystring(db, state->ksidstr);
375 DEBUG(10,("Stored %s <-> %s\n", state->ksidstr, state->kidstr));
378 talloc_free(tmp_ctx);
382 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom, const struct id_map *map)
384 struct idmap_tdb2_context *ctx;
386 char *ksidstr, *kidstr;
387 struct idmap_tdb2_set_mapping_context state;
389 if (!map || !map->sid) {
390 return NT_STATUS_INVALID_PARAMETER;
393 ksidstr = kidstr = NULL;
395 /* TODO: should we filter a set_mapping using low/high filters ? */
397 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
399 switch (map->xid.type) {
402 kidstr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
406 kidstr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
410 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
411 return NT_STATUS_INVALID_PARAMETER;
414 if (kidstr == NULL) {
415 DEBUG(0, ("ERROR: Out of memory!\n"));
416 ret = NT_STATUS_NO_MEMORY;
420 ksidstr = sid_string_talloc(ctx, map->sid);
421 if (ksidstr == NULL) {
422 DEBUG(0, ("Out of memory!\n"));
423 ret = NT_STATUS_NO_MEMORY;
427 state.ksidstr = ksidstr;
428 state.kidstr = kidstr;
430 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
434 talloc_free(ksidstr);
440 * Create a new mapping for an unmapped SID, also allocating a new ID.
441 * This should be run inside a transaction.
444 * Properly integrate this with multi domain idmap config:
445 * Currently, the allocator is default-config only.
447 static NTSTATUS idmap_tdb2_new_mapping(struct idmap_domain *dom, struct id_map *map)
452 ret = NT_STATUS_INVALID_PARAMETER;
456 if ((map->xid.type != ID_TYPE_UID) && (map->xid.type != ID_TYPE_GID)) {
457 ret = NT_STATUS_INVALID_PARAMETER;
461 if (map->sid == NULL) {
462 ret = NT_STATUS_INVALID_PARAMETER;
466 ret = idmap_tdb2_get_new_id(dom, &map->xid);
467 if (!NT_STATUS_IS_OK(ret)) {
468 DEBUG(3, ("Could not allocate id: %s\n", nt_errstr(ret)));
472 DEBUG(10, ("Setting mapping: %s <-> %s %lu\n",
473 sid_string_dbg(map->sid),
474 (map->xid.type == ID_TYPE_UID) ? "UID" : "GID",
475 (unsigned long)map->xid.id));
477 map->status = ID_MAPPED;
479 /* store the mapping */
480 ret = idmap_tdb2_set_mapping(dom, map);
481 if (!NT_STATUS_IS_OK(ret)) {
482 DEBUG(3, ("Could not store the new mapping: %s\n",
492 run a script to perform a mapping
494 The script should the following command lines:
500 and should return one of the following as a single line of text
506 static NTSTATUS idmap_tdb2_script(struct idmap_tdb2_context *ctx, struct id_map *map,
507 const char *fmt, ...)
515 cmd = talloc_asprintf(ctx, "%s ", ctx->script);
516 NT_STATUS_HAVE_NO_MEMORY(cmd);
519 cmd = talloc_vasprintf_append(cmd, fmt, ap);
521 NT_STATUS_HAVE_NO_MEMORY(cmd);
526 return NT_STATUS_NONE_MAPPED;
529 if (fgets(line, sizeof(line)-1, p) == NULL) {
531 return NT_STATUS_NONE_MAPPED;
535 DEBUG(10,("idmap script gave: %s\n", line));
537 if (sscanf(line, "UID:%lu", &v) == 1) {
539 map->xid.type = ID_TYPE_UID;
540 } else if (sscanf(line, "GID:%lu", &v) == 1) {
542 map->xid.type = ID_TYPE_GID;
543 } else if (strncmp(line, "SID:S-", 6) == 0) {
544 if (!string_to_sid(map->sid, &line[4])) {
545 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
547 return NT_STATUS_NONE_MAPPED;
550 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
552 return NT_STATUS_NONE_MAPPED;
561 Single id to sid lookup function.
563 static NTSTATUS idmap_tdb2_id_to_sid(struct idmap_domain *dom, struct id_map *map)
569 struct idmap_tdb2_context *ctx;
573 return NT_STATUS_INVALID_PARAMETER;
576 status = idmap_tdb2_open_db(dom);
577 NT_STATUS_NOT_OK_RETURN(status);
579 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
581 /* apply filters before checking */
582 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
583 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
584 map->xid.id, dom->low_id, dom->high_id));
585 return NT_STATUS_NONE_MAPPED;
588 switch (map->xid.type) {
591 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
595 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
599 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
600 return NT_STATUS_INVALID_PARAMETER;
603 /* final SAFE_FREE safe */
606 if (keystr == NULL) {
607 DEBUG(0, ("Out of memory!\n"));
608 ret = NT_STATUS_NO_MEMORY;
612 DEBUG(10,("Fetching record %s\n", keystr));
614 /* Check if the mapping exists */
615 data = dbwrap_fetch_bystring(ctx->db, keystr, keystr);
619 struct idmap_tdb2_set_mapping_context store_state;
621 DEBUG(10,("Record %s not found\n", keystr));
622 if (ctx->script == NULL) {
623 ret = NT_STATUS_NONE_MAPPED;
627 ret = idmap_tdb2_script(ctx, map, "IDTOSID %s", keystr);
629 /* store it on shared storage */
630 if (!NT_STATUS_IS_OK(ret)) {
634 sidstr = sid_string_talloc(keystr, map->sid);
636 ret = NT_STATUS_NO_MEMORY;
640 store_state.ksidstr = sidstr;
641 store_state.kidstr = keystr;
643 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
648 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
649 DEBUG(10,("INVALID SID (%s) in record %s\n",
650 (const char *)data.dptr, keystr));
651 ret = NT_STATUS_INTERNAL_DB_ERROR;
655 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
665 Single sid to id lookup function.
667 static NTSTATUS idmap_tdb2_sid_to_id(struct idmap_domain *dom, struct id_map *map)
672 unsigned long rec_id = 0;
673 struct idmap_tdb2_context *ctx;
674 TALLOC_CTX *tmp_ctx = talloc_stackframe();
676 ret = idmap_tdb2_open_db(dom);
677 NT_STATUS_NOT_OK_RETURN(ret);
679 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
681 keystr = sid_string_talloc(tmp_ctx, map->sid);
682 if (keystr == NULL) {
683 DEBUG(0, ("Out of memory!\n"));
684 ret = NT_STATUS_NO_MEMORY;
688 DEBUG(10,("Fetching record %s\n", keystr));
690 /* Check if sid is present in database */
691 data = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr);
694 struct idmap_tdb2_set_mapping_context store_state;
696 DEBUG(10,(__location__ " Record %s not found\n", keystr));
698 if (ctx->script == NULL) {
699 ret = NT_STATUS_NONE_MAPPED;
703 ret = idmap_tdb2_script(ctx, map, "SIDTOID %s", keystr);
704 /* store it on shared storage */
705 if (!NT_STATUS_IS_OK(ret)) {
709 /* apply filters before returning result */
710 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
711 DEBUG(5, ("Script returned id (%u) out of range "
712 "(%u - %u). Filtered!\n",
713 map->xid.id, dom->low_id, dom->high_id));
714 ret = NT_STATUS_NONE_MAPPED;
718 idstr = talloc_asprintf(tmp_ctx, "%cID %lu",
719 map->xid.type == ID_TYPE_UID?'U':'G',
720 (unsigned long)map->xid.id);
722 ret = NT_STATUS_NO_MEMORY;
726 store_state.ksidstr = keystr;
727 store_state.kidstr = idstr;
729 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
734 /* What type of record is this ? */
735 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
736 map->xid.id = rec_id;
737 map->xid.type = ID_TYPE_UID;
738 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
741 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
742 map->xid.id = rec_id;
743 map->xid.type = ID_TYPE_GID;
744 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
747 } else { /* Unknown record type ! */
748 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
749 ret = NT_STATUS_INTERNAL_DB_ERROR;
753 /* apply filters before returning result */
754 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
755 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
756 map->xid.id, dom->low_id, dom->high_id));
757 ret = NT_STATUS_NONE_MAPPED;
761 talloc_free(tmp_ctx);
766 lookup a set of unix ids.
768 static NTSTATUS idmap_tdb2_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
773 /* initialize the status to avoid suprise */
774 for (i = 0; ids[i]; i++) {
775 ids[i]->status = ID_UNKNOWN;
778 for (i = 0; ids[i]; i++) {
779 ret = idmap_tdb2_id_to_sid(dom, ids[i]);
780 if ( ! NT_STATUS_IS_OK(ret)) {
782 /* if it is just a failed mapping continue */
783 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
785 /* make sure it is marked as unmapped */
786 ids[i]->status = ID_UNMAPPED;
790 /* some fatal error occurred, return immediately */
794 /* all ok, id is mapped */
795 ids[i]->status = ID_MAPPED;
805 lookup a set of sids.
808 struct idmap_tdb2_sids_to_unixids_context {
809 struct idmap_domain *dom;
811 bool allocate_unmapped;
814 static NTSTATUS idmap_tdb2_sids_to_unixids_action(struct db_context *db,
817 struct idmap_tdb2_sids_to_unixids_context *state;
819 NTSTATUS ret = NT_STATUS_OK;
821 state = (struct idmap_tdb2_sids_to_unixids_context *)private_data;
823 DEBUG(10, ("idmap_tdb2_sids_to_unixids_action: "
824 " domain: [%s], allocate: %s\n",
826 state->allocate_unmapped ? "yes" : "no"));
828 for (i = 0; state->ids[i]; i++) {
829 if ((state->ids[i]->status == ID_UNKNOWN) ||
830 /* retry if we could not map in previous run: */
831 (state->ids[i]->status == ID_UNMAPPED))
835 ret2 = idmap_tdb2_sid_to_id(state->dom, state->ids[i]);
836 if (!NT_STATUS_IS_OK(ret2)) {
838 /* if it is just a failed mapping, continue */
839 if (NT_STATUS_EQUAL(ret2, NT_STATUS_NONE_MAPPED)) {
841 /* make sure it is marked as unmapped */
842 state->ids[i]->status = ID_UNMAPPED;
843 ret = STATUS_SOME_UNMAPPED;
845 /* some fatal error occurred, return immediately */
850 /* all ok, id is mapped */
851 state->ids[i]->status = ID_MAPPED;
855 if ((state->ids[i]->status == ID_UNMAPPED) &&
856 state->allocate_unmapped)
858 ret = idmap_tdb2_new_mapping(state->dom, state->ids[i]);
859 if (!NT_STATUS_IS_OK(ret)) {
869 static NTSTATUS idmap_tdb2_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
873 struct idmap_tdb2_sids_to_unixids_context state;
874 struct idmap_tdb2_context *ctx;
876 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
878 /* initialize the status to avoid suprise */
879 for (i = 0; ids[i]; i++) {
880 ids[i]->status = ID_UNKNOWN;
885 state.allocate_unmapped = false;
887 ret = idmap_tdb2_sids_to_unixids_action(ctx->db, &state);
889 if (NT_STATUS_EQUAL(ret, STATUS_SOME_UNMAPPED) && !dom->read_only) {
890 state.allocate_unmapped = true;
891 ret = dbwrap_trans_do(ctx->db,
892 idmap_tdb2_sids_to_unixids_action,
901 Close the idmap tdb instance
903 static NTSTATUS idmap_tdb2_close(struct idmap_domain *dom)
905 /* don't do anything */
909 static struct idmap_methods db_methods = {
910 .init = idmap_tdb2_db_init,
911 .unixids_to_sids = idmap_tdb2_unixids_to_sids,
912 .sids_to_unixids = idmap_tdb2_sids_to_unixids,
913 .allocate_id = idmap_tdb2_get_new_id,
914 .close_fn = idmap_tdb2_close
917 NTSTATUS idmap_tdb2_init(void)
919 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_methods);