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.
35 #include "system/filesys.h"
39 #include "dbwrap/dbwrap.h"
40 #include "dbwrap/dbwrap_open.h"
41 #include "../libcli/security/dom_sid.h"
45 #define DBGC_CLASS DBGC_IDMAP
47 struct idmap_tdb2_context {
48 struct db_context *db;
49 const char *script; /* script to provide idmaps */
50 struct idmap_rw_ops *rw_ops;
53 /* High water mark keys */
54 #define HWM_GROUP "GROUP HWM"
55 #define HWM_USER "USER HWM"
59 * check and initialize high/low water marks in the db
61 static NTSTATUS idmap_tdb2_init_hwm(struct idmap_domain *dom)
65 struct idmap_tdb2_context *ctx;
67 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
69 /* Create high water marks for group and user id */
71 status = dbwrap_fetch_uint32(ctx->db, HWM_USER, &low_id);
72 if (!NT_STATUS_IS_OK(status) || (low_id < dom->low_id)) {
73 status = dbwrap_trans_store_uint32(ctx->db, HWM_USER,
75 if (!NT_STATUS_IS_OK(status)) {
76 DEBUG(0, ("Unable to initialise user hwm in idmap "
77 "database: %s\n", nt_errstr(status)));
78 return NT_STATUS_INTERNAL_DB_ERROR;
82 status = dbwrap_fetch_uint32(ctx->db, HWM_GROUP, &low_id);
83 if (!NT_STATUS_IS_OK(status) || (low_id < dom->low_id)) {
84 status = dbwrap_trans_store_uint32(ctx->db, HWM_GROUP,
86 if (!NT_STATUS_IS_OK(status)) {
87 DEBUG(0, ("Unable to initialise group hwm in idmap "
88 "database: %s\n", nt_errstr(status)));
89 return NT_STATUS_INTERNAL_DB_ERROR;
98 open the permanent tdb
100 static NTSTATUS idmap_tdb2_open_db(struct idmap_domain *dom)
103 struct idmap_tdb2_context *ctx;
105 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
108 /* its already open */
112 db_path = talloc_asprintf(NULL, "%s/idmap2.tdb", lp_private_dir());
113 NT_STATUS_HAVE_NO_MEMORY(db_path);
115 /* Open idmap repository */
116 ctx->db = db_open(ctx, db_path, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0644);
117 TALLOC_FREE(db_path);
119 if (ctx->db == NULL) {
120 DEBUG(0, ("Unable to open idmap_tdb2 database '%s'\n",
122 return NT_STATUS_UNSUCCESSFUL;
125 return idmap_tdb2_init_hwm(dom);
133 struct idmap_tdb2_allocate_id_context {
140 static NTSTATUS idmap_tdb2_allocate_id_action(struct db_context *db,
144 struct idmap_tdb2_allocate_id_context *state;
147 state = (struct idmap_tdb2_allocate_id_context *)private_data;
149 ret = dbwrap_fetch_uint32(db, state->hwmkey, &hwm);
150 if (!NT_STATUS_IS_OK(ret)) {
151 ret = NT_STATUS_INTERNAL_DB_ERROR;
155 /* check it is in the range */
156 if (hwm > state->high_hwm) {
157 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
158 state->hwmtype, (unsigned long)state->high_hwm));
159 ret = NT_STATUS_UNSUCCESSFUL;
163 /* fetch a new id and increment it */
164 ret = dbwrap_trans_change_uint32_atomic(db, state->hwmkey, &hwm, 1);
165 if (!NT_STATUS_IS_OK(ret)) {
166 DEBUG(1, ("Fatal error while fetching a new %s value\n!",
171 /* recheck it is in the range */
172 if (hwm > state->high_hwm) {
173 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
174 state->hwmtype, (unsigned long)state->high_hwm));
175 ret = NT_STATUS_UNSUCCESSFUL;
186 static NTSTATUS idmap_tdb2_allocate_id(struct idmap_domain *dom,
194 struct idmap_tdb2_allocate_id_context state;
195 struct idmap_tdb2_context *ctx;
197 status = idmap_tdb2_open_db(dom);
198 NT_STATUS_NOT_OK_RETURN(status);
200 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
202 /* Get current high water mark */
216 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
217 return NT_STATUS_INVALID_PARAMETER;
220 high_hwm = dom->high_id;
223 state.high_hwm = high_hwm;
224 state.hwmtype = hwmtype;
225 state.hwmkey = hwmkey;
227 status = dbwrap_trans_do(ctx->db, idmap_tdb2_allocate_id_action,
230 if (NT_STATUS_IS_OK(status)) {
232 DEBUG(10,("New %s = %d\n", hwmtype, state.hwm));
234 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
241 * Allocate a new unix-ID.
242 * For now this is for the default idmap domain only.
243 * Should be extended later on.
245 static NTSTATUS idmap_tdb2_get_new_id(struct idmap_domain *dom,
250 if (!strequal(dom->name, "*")) {
251 DEBUG(3, ("idmap_tdb2_get_new_id: "
252 "Refusing creation of mapping for domain'%s'. "
253 "Currently only supported for the default "
256 return NT_STATUS_NOT_IMPLEMENTED;
259 ret = idmap_tdb2_allocate_id(dom, id);
265 IDMAP MAPPING TDB BACKEND
268 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom,
269 const struct id_map *map);
272 Initialise idmap database.
274 static NTSTATUS idmap_tdb2_db_init(struct idmap_domain *dom)
277 struct idmap_tdb2_context *ctx;
278 char *config_option = NULL;
279 const char * idmap_script = NULL;
281 ctx = talloc_zero(dom, struct idmap_tdb2_context);
283 DEBUG(0, ("Out of memory!\n"));
284 return NT_STATUS_NO_MEMORY;
287 config_option = talloc_asprintf(ctx, "idmap config %s", dom->name);
288 if (config_option == NULL) {
289 DEBUG(0, ("Out of memory!\n"));
290 ret = NT_STATUS_NO_MEMORY;
293 ctx->script = lp_parm_const_string(-1, config_option, "script", NULL);
294 talloc_free(config_option);
296 idmap_script = lp_parm_const_string(-1, "idmap", "script", NULL);
297 if (idmap_script != NULL) {
298 DEBUG(0, ("Warning: 'idmap:script' is deprecated. "
299 " Please use 'idmap config * : script' instead!\n"));
302 if (strequal(dom->name, "*") && ctx->script == NULL) {
303 /* fall back to idmap:script for backwards compatibility */
304 ctx->script = idmap_script;
308 DEBUG(1, ("using idmap script '%s'\n", ctx->script));
311 ctx->rw_ops = talloc_zero(ctx, struct idmap_rw_ops);
312 if (ctx->rw_ops == NULL) {
313 DEBUG(0, ("Out of memory!\n"));
314 ret = NT_STATUS_NO_MEMORY;
318 ctx->rw_ops->get_new_id = idmap_tdb2_get_new_id;
319 ctx->rw_ops->set_mapping = idmap_tdb2_set_mapping;
321 dom->private_data = ctx;
323 ret = idmap_tdb2_open_db(dom);
324 if (!NT_STATUS_IS_OK(ret)) {
337 * store a mapping in the database.
340 struct idmap_tdb2_set_mapping_context {
345 static NTSTATUS idmap_tdb2_set_mapping_action(struct db_context *db,
350 struct idmap_tdb2_set_mapping_context *state;
351 TALLOC_CTX *tmp_ctx = talloc_stackframe();
353 state = (struct idmap_tdb2_set_mapping_context *)private_data;
355 DEBUG(10, ("Storing %s <-> %s map\n", state->ksidstr, state->kidstr));
357 /* check wheter sid mapping is already present in db */
358 ret = dbwrap_fetch_bystring(db, tmp_ctx, state->ksidstr, &data);
359 if (!NT_STATUS_IS_OK(ret)) {
360 ret = NT_STATUS_OBJECT_NAME_COLLISION;
364 ret = dbwrap_store_bystring(db, state->ksidstr,
365 string_term_tdb_data(state->kidstr),
367 if (!NT_STATUS_IS_OK(ret)) {
368 DEBUG(0, ("Error storing SID -> ID: %s\n", nt_errstr(ret)));
372 ret = dbwrap_store_bystring(db, state->kidstr,
373 string_term_tdb_data(state->ksidstr),
375 if (!NT_STATUS_IS_OK(ret)) {
376 DEBUG(0, ("Error storing ID -> SID: %s\n", nt_errstr(ret)));
377 /* try to remove the previous stored SID -> ID map */
378 dbwrap_delete_bystring(db, state->ksidstr);
382 DEBUG(10,("Stored %s <-> %s\n", state->ksidstr, state->kidstr));
385 talloc_free(tmp_ctx);
389 static NTSTATUS idmap_tdb2_set_mapping(struct idmap_domain *dom, const struct id_map *map)
391 struct idmap_tdb2_context *ctx;
393 char *ksidstr, *kidstr;
394 struct idmap_tdb2_set_mapping_context state;
396 if (!map || !map->sid) {
397 return NT_STATUS_INVALID_PARAMETER;
400 ksidstr = kidstr = NULL;
402 /* TODO: should we filter a set_mapping using low/high filters ? */
404 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
406 switch (map->xid.type) {
409 kidstr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
413 kidstr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
417 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
418 return NT_STATUS_INVALID_PARAMETER;
421 if (kidstr == NULL) {
422 DEBUG(0, ("ERROR: Out of memory!\n"));
423 ret = NT_STATUS_NO_MEMORY;
427 ksidstr = sid_string_talloc(ctx, map->sid);
428 if (ksidstr == NULL) {
429 DEBUG(0, ("Out of memory!\n"));
430 ret = NT_STATUS_NO_MEMORY;
434 state.ksidstr = ksidstr;
435 state.kidstr = kidstr;
437 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
441 talloc_free(ksidstr);
447 * Create a new mapping for an unmapped SID, also allocating a new ID.
448 * This should be run inside a transaction.
451 * Properly integrate this with multi domain idmap config:
452 * Currently, the allocator is default-config only.
454 static NTSTATUS idmap_tdb2_new_mapping(struct idmap_domain *dom, struct id_map *map)
457 struct idmap_tdb2_context *ctx;
459 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
461 ret = idmap_rw_new_mapping(dom, ctx->rw_ops, map);
468 run a script to perform a mapping
470 The script should the following command lines:
476 and should return one of the following as a single line of text
482 static NTSTATUS idmap_tdb2_script(struct idmap_tdb2_context *ctx, struct id_map *map,
483 const char *fmt, ...)
491 cmd = talloc_asprintf(ctx, "%s ", ctx->script);
492 NT_STATUS_HAVE_NO_MEMORY(cmd);
495 cmd = talloc_vasprintf_append(cmd, fmt, ap);
497 NT_STATUS_HAVE_NO_MEMORY(cmd);
502 return NT_STATUS_NONE_MAPPED;
505 if (fgets(line, sizeof(line)-1, p) == NULL) {
507 return NT_STATUS_NONE_MAPPED;
511 DEBUG(10,("idmap script gave: %s\n", line));
513 if (sscanf(line, "UID:%lu", &v) == 1) {
515 map->xid.type = ID_TYPE_UID;
516 } else if (sscanf(line, "GID:%lu", &v) == 1) {
518 map->xid.type = ID_TYPE_GID;
519 } else if (strncmp(line, "SID:S-", 6) == 0) {
520 if (!string_to_sid(map->sid, &line[4])) {
521 DEBUG(0,("Bad SID in '%s' from idmap script %s\n",
523 return NT_STATUS_NONE_MAPPED;
526 DEBUG(0,("Bad reply '%s' from idmap script %s\n",
528 return NT_STATUS_NONE_MAPPED;
537 Single id to sid lookup function.
539 static NTSTATUS idmap_tdb2_id_to_sid(struct idmap_domain *dom, struct id_map *map)
545 struct idmap_tdb2_context *ctx;
549 return NT_STATUS_INVALID_PARAMETER;
552 status = idmap_tdb2_open_db(dom);
553 NT_STATUS_NOT_OK_RETURN(status);
555 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
557 /* apply filters before checking */
558 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
559 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
560 map->xid.id, dom->low_id, dom->high_id));
561 return NT_STATUS_NONE_MAPPED;
564 switch (map->xid.type) {
567 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
571 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
575 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
576 return NT_STATUS_INVALID_PARAMETER;
579 if (keystr == NULL) {
580 DEBUG(0, ("Out of memory!\n"));
581 ret = NT_STATUS_NO_MEMORY;
585 DEBUG(10,("Fetching record %s\n", keystr));
587 /* Check if the mapping exists */
588 status = dbwrap_fetch_bystring(ctx->db, keystr, keystr, &data);
590 if (!NT_STATUS_IS_OK(status)) {
592 struct idmap_tdb2_set_mapping_context store_state;
594 DEBUG(10,("Record %s not found\n", keystr));
595 if (ctx->script == NULL) {
596 ret = NT_STATUS_NONE_MAPPED;
600 ret = idmap_tdb2_script(ctx, map, "IDTOSID %s", keystr);
601 if (!NT_STATUS_IS_OK(ret)) {
605 sidstr = sid_string_talloc(keystr, map->sid);
607 ret = NT_STATUS_NO_MEMORY;
611 store_state.ksidstr = sidstr;
612 store_state.kidstr = keystr;
614 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
619 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
620 DEBUG(10,("INVALID SID (%s) in record %s\n",
621 (const char *)data.dptr, keystr));
622 ret = NT_STATUS_INTERNAL_DB_ERROR;
626 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
636 Single sid to id lookup function.
638 static NTSTATUS idmap_tdb2_sid_to_id(struct idmap_domain *dom, struct id_map *map)
643 unsigned long rec_id = 0;
644 struct idmap_tdb2_context *ctx;
645 TALLOC_CTX *tmp_ctx = talloc_stackframe();
647 ret = idmap_tdb2_open_db(dom);
648 NT_STATUS_NOT_OK_RETURN(ret);
650 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
652 keystr = sid_string_talloc(tmp_ctx, map->sid);
653 if (keystr == NULL) {
654 DEBUG(0, ("Out of memory!\n"));
655 ret = NT_STATUS_NO_MEMORY;
659 DEBUG(10,("Fetching record %s\n", keystr));
661 /* Check if sid is present in database */
662 ret = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr, &data);
663 if (!NT_STATUS_IS_OK(ret)) {
665 struct idmap_tdb2_set_mapping_context store_state;
667 DEBUG(10,(__location__ " Record %s not found\n", keystr));
669 if (ctx->script == NULL) {
670 ret = NT_STATUS_NONE_MAPPED;
674 ret = idmap_tdb2_script(ctx, map, "SIDTOID %s", keystr);
675 if (!NT_STATUS_IS_OK(ret)) {
679 /* apply filters before returning result */
680 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
681 DEBUG(5, ("Script returned id (%u) out of range "
682 "(%u - %u). Filtered!\n",
683 map->xid.id, dom->low_id, dom->high_id));
684 ret = NT_STATUS_NONE_MAPPED;
688 idstr = talloc_asprintf(tmp_ctx, "%cID %lu",
689 map->xid.type == ID_TYPE_UID?'U':'G',
690 (unsigned long)map->xid.id);
692 ret = NT_STATUS_NO_MEMORY;
696 store_state.ksidstr = keystr;
697 store_state.kidstr = idstr;
699 ret = dbwrap_trans_do(ctx->db, idmap_tdb2_set_mapping_action,
704 /* What type of record is this ? */
705 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
706 map->xid.id = rec_id;
707 map->xid.type = ID_TYPE_UID;
708 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
711 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
712 map->xid.id = rec_id;
713 map->xid.type = ID_TYPE_GID;
714 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
717 } else { /* Unknown record type ! */
718 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
719 ret = NT_STATUS_INTERNAL_DB_ERROR;
723 /* apply filters before returning result */
724 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
725 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
726 map->xid.id, dom->low_id, dom->high_id));
727 ret = NT_STATUS_NONE_MAPPED;
731 talloc_free(tmp_ctx);
736 lookup a set of unix ids.
738 static NTSTATUS idmap_tdb2_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
743 /* initialize the status to avoid suprise */
744 for (i = 0; ids[i]; i++) {
745 ids[i]->status = ID_UNKNOWN;
748 for (i = 0; ids[i]; i++) {
749 ret = idmap_tdb2_id_to_sid(dom, ids[i]);
750 if ( ! NT_STATUS_IS_OK(ret)) {
752 /* if it is just a failed mapping continue */
753 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
755 /* make sure it is marked as unmapped */
756 ids[i]->status = ID_UNMAPPED;
760 /* some fatal error occurred, return immediately */
764 /* all ok, id is mapped */
765 ids[i]->status = ID_MAPPED;
775 lookup a set of sids.
778 struct idmap_tdb2_sids_to_unixids_context {
779 struct idmap_domain *dom;
781 bool allocate_unmapped;
784 static NTSTATUS idmap_tdb2_sids_to_unixids_action(struct db_context *db,
787 struct idmap_tdb2_sids_to_unixids_context *state;
789 NTSTATUS ret = NT_STATUS_OK;
791 state = (struct idmap_tdb2_sids_to_unixids_context *)private_data;
793 DEBUG(10, ("idmap_tdb2_sids_to_unixids_action: "
794 " domain: [%s], allocate: %s\n",
796 state->allocate_unmapped ? "yes" : "no"));
798 for (i = 0; state->ids[i]; i++) {
799 if ((state->ids[i]->status == ID_UNKNOWN) ||
800 /* retry if we could not map in previous run: */
801 (state->ids[i]->status == ID_UNMAPPED))
805 ret2 = idmap_tdb2_sid_to_id(state->dom, state->ids[i]);
806 if (!NT_STATUS_IS_OK(ret2)) {
808 /* if it is just a failed mapping, continue */
809 if (NT_STATUS_EQUAL(ret2, NT_STATUS_NONE_MAPPED)) {
811 /* make sure it is marked as unmapped */
812 state->ids[i]->status = ID_UNMAPPED;
813 ret = STATUS_SOME_UNMAPPED;
815 /* some fatal error occurred, return immediately */
820 /* all ok, id is mapped */
821 state->ids[i]->status = ID_MAPPED;
825 if ((state->ids[i]->status == ID_UNMAPPED) &&
826 state->allocate_unmapped)
828 ret = idmap_tdb2_new_mapping(state->dom, state->ids[i]);
829 if (!NT_STATUS_IS_OK(ret)) {
839 static NTSTATUS idmap_tdb2_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
843 struct idmap_tdb2_sids_to_unixids_context state;
844 struct idmap_tdb2_context *ctx;
846 ctx = talloc_get_type(dom->private_data, struct idmap_tdb2_context);
848 /* initialize the status to avoid suprise */
849 for (i = 0; ids[i]; i++) {
850 ids[i]->status = ID_UNKNOWN;
855 state.allocate_unmapped = false;
857 ret = idmap_tdb2_sids_to_unixids_action(ctx->db, &state);
859 if (NT_STATUS_EQUAL(ret, STATUS_SOME_UNMAPPED) && !dom->read_only) {
860 state.allocate_unmapped = true;
861 ret = dbwrap_trans_do(ctx->db,
862 idmap_tdb2_sids_to_unixids_action,
870 static struct idmap_methods db_methods = {
871 .init = idmap_tdb2_db_init,
872 .unixids_to_sids = idmap_tdb2_unixids_to_sids,
873 .sids_to_unixids = idmap_tdb2_sids_to_unixids,
874 .allocate_id = idmap_tdb2_get_new_id
877 NTSTATUS samba_init_module(void)
879 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb2", &db_methods);