2 Unix SMB/CIFS implementation.
6 Copyright (C) Tim Potter 2000
7 Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
8 Copyright (C) Jeremy Allison 2006
9 Copyright (C) Simo Sorce 2003-2006
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #define DBGC_CLASS DBGC_IDMAP
31 /* idmap version determines auto-conversion - this is the database
32 structure version specifier. */
34 #define IDMAP_VERSION 2
36 struct idmap_tdb_context {
37 struct db_context *db;
40 /* High water mark keys */
41 #define HWM_GROUP "GROUP HWM"
42 #define HWM_USER "USER HWM"
44 static struct idmap_tdb_state {
46 /* User and group id pool */
47 uid_t low_uid, high_uid; /* Range of uids to allocate */
48 gid_t low_gid, high_gid; /* Range of gids to allocate */
52 struct convert_fn_state {
53 struct db_context *db;
57 /*****************************************************************************
58 For idmap conversion: convert one record to new format
59 Ancient versions (eg 2.2.3a) of winbindd_idmap.tdb mapped DOMAINNAME/rid
61 *****************************************************************************/
62 static int convert_fn(struct db_record *rec, void *private_data)
64 struct winbindd_domain *domain;
72 struct convert_fn_state *s = (struct convert_fn_state *)private_data;
74 DEBUG(10,("Converting %s\n", (const char *)rec->key.dptr));
76 p = strchr((const char *)rec->key.dptr, '/');
81 fstrcpy(dom_name, (const char *)rec->key.dptr);
84 domain = find_domain_from_name(dom_name);
86 /* We must delete the old record. */
87 DEBUG(0,("Unable to find domain %s\n", dom_name ));
88 DEBUG(0,("deleting record %s\n", (const char *)rec->key.dptr ));
90 status = rec->delete_rec(rec);
91 if (!NT_STATUS_IS_OK(status)) {
92 DEBUG(0, ("Unable to delete record %s:%s\n",
93 (const char *)rec->key.dptr,
104 sid_compose(&sid, &domain->sid, rid);
106 sid_to_fstring(keystr, &sid);
107 key2 = string_term_tdb_data(keystr);
109 status = dbwrap_store(s->db, key2, rec->value, TDB_INSERT);
110 if (!NT_STATUS_IS_OK(status)) {
111 DEBUG(0,("Unable to add record %s:%s\n",
112 (const char *)key2.dptr,
118 status = dbwrap_store(s->db, rec->value, key2, TDB_REPLACE);
119 if (!NT_STATUS_IS_OK(status)) {
120 DEBUG(0,("Unable to update record %s:%s\n",
121 (const char *)rec->value.dptr,
127 status = rec->delete_rec(rec);
128 if (!NT_STATUS_IS_OK(status)) {
129 DEBUG(0,("Unable to delete record %s:%s\n",
130 (const char *)rec->key.dptr,
139 /*****************************************************************************
140 Convert the idmap database from an older version.
141 *****************************************************************************/
143 static bool idmap_tdb_upgrade(struct idmap_domain *dom, struct db_context *db)
146 bool bigendianheader;
147 struct convert_fn_state s;
149 DEBUG(0, ("Upgrading winbindd_idmap.tdb from an old version\n"));
151 bigendianheader = (db->get_flags(db) & TDB_BIGENDIAN) ? True : False;
153 vers = dbwrap_fetch_int32(db, "IDMAP_VERSION");
155 if (((vers == -1) && bigendianheader) || (IREV(vers) == IDMAP_VERSION)) {
156 /* Arrggghh ! Bytereversed or old big-endian - make order independent ! */
158 * high and low records were created on a
159 * big endian machine and will need byte-reversing.
164 wm = dbwrap_fetch_int32(db, HWM_USER);
172 if (dbwrap_store_int32(db, HWM_USER, wm) == -1) {
173 DEBUG(0, ("Unable to byteswap user hwm in idmap database\n"));
177 wm = dbwrap_fetch_int32(db, HWM_GROUP);
184 if (dbwrap_store_int32(db, HWM_GROUP, wm) == -1) {
185 DEBUG(0, ("Unable to byteswap group hwm in idmap database\n"));
193 /* the old format stored as DOMAIN/rid - now we store the SID direct */
194 db->traverse(db, convert_fn, &s);
197 DEBUG(0, ("Problem during conversion\n"));
201 if (dbwrap_store_int32(db, "IDMAP_VERSION", IDMAP_VERSION) == -1) {
202 DEBUG(0, ("Unable to store idmap version in databse\n"));
209 static NTSTATUS idmap_tdb_init_hwm(struct idmap_domain *dom)
214 bool update_uid = false;
215 bool update_gid = false;
216 struct idmap_tdb_context *ctx;
218 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
220 low_uid = dbwrap_fetch_int32(ctx->db, HWM_USER);
221 if (low_uid == -1 || low_uid < dom->low_id) {
225 low_gid = dbwrap_fetch_int32(ctx->db, HWM_GROUP);
226 if (low_gid == -1 || low_gid < dom->low_id) {
230 if (!update_uid && !update_gid) {
234 if (ctx->db->transaction_start(ctx->db) != 0) {
235 DEBUG(0, ("Unable to start upgrade transaction!\n"));
236 return NT_STATUS_INTERNAL_DB_ERROR;
240 ret = dbwrap_store_int32(ctx->db, HWM_USER, dom->low_id);
242 ctx->db->transaction_cancel(ctx->db);
243 DEBUG(0, ("Unable to initialise user hwm in idmap "
245 return NT_STATUS_INTERNAL_DB_ERROR;
250 ret = dbwrap_store_int32(ctx->db, HWM_GROUP, dom->low_id);
252 ctx->db->transaction_cancel(ctx->db);
253 DEBUG(0, ("Unable to initialise group hwm in idmap "
255 return NT_STATUS_INTERNAL_DB_ERROR;
259 if (ctx->db->transaction_commit(ctx->db) != 0) {
260 DEBUG(0, ("Unable to commit upgrade transaction!\n"));
261 return NT_STATUS_INTERNAL_DB_ERROR;
267 static NTSTATUS idmap_tdb_open_db(struct idmap_domain *dom)
271 char *tdbfile = NULL;
272 struct db_context *db = NULL;
274 bool config_error = false;
275 struct idmap_tdb_context *ctx;
277 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
279 /* use our own context here */
280 mem_ctx = talloc_stackframe();
282 /* use the old database if present */
283 tdbfile = state_path("winbindd_idmap.tdb");
285 DEBUG(0, ("Out of memory!\n"));
286 ret = NT_STATUS_NO_MEMORY;
290 DEBUG(10,("Opening tdbfile %s\n", tdbfile ));
292 /* Open idmap repository */
293 db = db_open(mem_ctx, tdbfile, 0, TDB_DEFAULT, O_RDWR | O_CREAT, 0644);
295 DEBUG(0, ("Unable to open idmap database\n"));
296 ret = NT_STATUS_UNSUCCESSFUL;
300 /* check against earlier versions */
301 version = dbwrap_fetch_int32(db, "IDMAP_VERSION");
302 if (version != IDMAP_VERSION) {
304 DEBUG(0,("Upgrade of IDMAP_VERSION from %d to %d is not "
305 "possible with incomplete configuration\n",
306 version, IDMAP_VERSION));
307 ret = NT_STATUS_UNSUCCESSFUL;
310 if (db->transaction_start(db) != 0) {
311 DEBUG(0, ("Unable to start upgrade transaction!\n"));
312 ret = NT_STATUS_INTERNAL_DB_ERROR;
316 if (!idmap_tdb_upgrade(dom, db)) {
317 db->transaction_cancel(db);
318 DEBUG(0, ("Unable to open idmap database, it's in an old format, and upgrade failed!\n"));
319 ret = NT_STATUS_INTERNAL_DB_ERROR;
323 if (db->transaction_commit(db) != 0) {
324 DEBUG(0, ("Unable to commit upgrade transaction!\n"));
325 ret = NT_STATUS_INTERNAL_DB_ERROR;
330 ctx->db = talloc_move(ctx, &db);
332 ret = idmap_tdb_init_hwm(dom);
335 talloc_free(mem_ctx);
339 /**********************************************************************
340 IDMAP ALLOC TDB BACKEND
341 **********************************************************************/
343 static struct db_context *idmap_alloc_db;
345 /**********************************
347 **********************************/
349 struct idmap_tdb_allocate_id_context {
356 static NTSTATUS idmap_tdb_allocate_id_action(struct db_context *db,
360 struct idmap_tdb_allocate_id_context *state;
363 state = (struct idmap_tdb_allocate_id_context *)private_data;
365 hwm = dbwrap_fetch_int32(db, state->hwmkey);
367 ret = NT_STATUS_INTERNAL_DB_ERROR;
371 /* check it is in the range */
372 if (hwm > state->high_hwm) {
373 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
374 state->hwmtype, (unsigned long)state->high_hwm));
375 ret = NT_STATUS_UNSUCCESSFUL;
379 /* fetch a new id and increment it */
380 ret = dbwrap_trans_change_uint32_atomic(db, state->hwmkey, &hwm, 1);
381 if (!NT_STATUS_IS_OK(ret)) {
382 DEBUG(0, ("Fatal error while fetching a new %s value: %s\n!",
383 state->hwmtype, nt_errstr(ret)));
387 /* recheck it is in the range */
388 if (hwm > state->high_hwm) {
389 DEBUG(1, ("Fatal Error: %s range full!! (max: %lu)\n",
390 state->hwmtype, (unsigned long)state->high_hwm));
391 ret = NT_STATUS_UNSUCCESSFUL;
402 static NTSTATUS idmap_tdb_allocate_id(struct idmap_domain *dom,
410 struct idmap_tdb_allocate_id_context state;
411 struct idmap_tdb_context *ctx;
413 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
415 /* Get current high water mark */
429 DEBUG(2, ("Invalid ID type (0x%x)\n", xid->type));
430 return NT_STATUS_INVALID_PARAMETER;
433 high_hwm = dom->high_id;
436 state.high_hwm = high_hwm;
437 state.hwmtype = hwmtype;
438 state.hwmkey = hwmkey;
440 status = dbwrap_trans_do(ctx->db, idmap_tdb_allocate_id_action,
443 if (NT_STATUS_IS_OK(status)) {
445 DEBUG(10,("New %s = %d\n", hwmtype, state.hwm));
447 DEBUG(1, ("Error allocating a new %s\n", hwmtype));
454 * Allocate a new unix-ID.
455 * For now this is for the default idmap domain only.
456 * Should be extended later on.
458 static NTSTATUS idmap_tdb_get_new_id(struct idmap_domain *dom,
463 if (!strequal(dom->name, "*")) {
464 DEBUG(3, ("idmap_tdb_get_new_id: "
465 "Refusing allocation of a new unixid for domain'%s'. "
466 "Currently only supported for the default "
469 return NT_STATUS_NOT_IMPLEMENTED;
472 ret = idmap_tdb_allocate_id(dom, id);
477 /**********************************************************************
478 IDMAP MAPPING TDB BACKEND
479 **********************************************************************/
481 /*****************************
482 Initialise idmap database.
483 *****************************/
485 static NTSTATUS idmap_tdb_db_init(struct idmap_domain *dom, const char *params)
488 struct idmap_tdb_context *ctx;
490 DEBUG(10, ("idmap_tdb_db_init called for domain '%s'\n", dom->name));
492 ctx = talloc(dom, struct idmap_tdb_context);
494 DEBUG(0, ("Out of memory!\n"));
495 return NT_STATUS_NO_MEMORY;
498 /* load backend specific configuration here: */
500 if (strequal(dom->name, "*")) {
505 dom->private_data = ctx;
507 ret = idmap_tdb_open_db(dom);
508 if ( ! NT_STATUS_IS_OK(ret)) {
519 /**********************************
520 Single id to sid lookup function.
521 **********************************/
523 static NTSTATUS idmap_tdb_id_to_sid(struct idmap_domain *dom, struct id_map *map)
528 struct idmap_tdb_context *ctx;
531 return NT_STATUS_INVALID_PARAMETER;
534 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
536 /* apply filters before checking */
537 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
538 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
539 map->xid.id, dom->low_id, dom->high_id));
540 return NT_STATUS_NONE_MAPPED;
543 switch (map->xid.type) {
546 keystr = talloc_asprintf(ctx, "UID %lu", (unsigned long)map->xid.id);
550 keystr = talloc_asprintf(ctx, "GID %lu", (unsigned long)map->xid.id);
554 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
555 return NT_STATUS_INVALID_PARAMETER;
558 /* final SAFE_FREE safe */
561 if (keystr == NULL) {
562 DEBUG(0, ("Out of memory!\n"));
563 ret = NT_STATUS_NO_MEMORY;
567 DEBUG(10,("Fetching record %s\n", keystr));
569 /* Check if the mapping exists */
570 data = dbwrap_fetch_bystring(ctx->db, NULL, keystr);
573 DEBUG(10,("Record %s not found\n", keystr));
574 ret = NT_STATUS_NONE_MAPPED;
578 if (!string_to_sid(map->sid, (const char *)data.dptr)) {
579 DEBUG(10,("INVALID SID (%s) in record %s\n",
580 (const char *)data.dptr, keystr));
581 ret = NT_STATUS_INTERNAL_DB_ERROR;
585 DEBUG(10,("Found record %s -> %s\n", keystr, (const char *)data.dptr));
589 talloc_free(data.dptr);
594 /**********************************
595 Single sid to id lookup function.
596 **********************************/
598 static NTSTATUS idmap_tdb_sid_to_id(struct idmap_domain *dom, struct id_map *map)
603 unsigned long rec_id = 0;
604 struct idmap_tdb_context *ctx;
605 TALLOC_CTX *tmp_ctx = talloc_stackframe();
607 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
609 keystr = sid_string_talloc(tmp_ctx, map->sid);
610 if (keystr == NULL) {
611 DEBUG(0, ("Out of memory!\n"));
612 ret = NT_STATUS_NO_MEMORY;
616 DEBUG(10,("Fetching record %s\n", keystr));
618 /* Check if sid is present in database */
619 data = dbwrap_fetch_bystring(ctx->db, tmp_ctx, keystr);
621 DEBUG(10,("Record %s not found\n", keystr));
622 ret = NT_STATUS_NONE_MAPPED;
626 /* What type of record is this ? */
627 if (sscanf((const char *)data.dptr, "UID %lu", &rec_id) == 1) { /* Try a UID record. */
628 map->xid.id = rec_id;
629 map->xid.type = ID_TYPE_UID;
630 DEBUG(10,("Found uid record %s -> %s \n", keystr, (const char *)data.dptr ));
633 } else if (sscanf((const char *)data.dptr, "GID %lu", &rec_id) == 1) { /* Try a GID record. */
634 map->xid.id = rec_id;
635 map->xid.type = ID_TYPE_GID;
636 DEBUG(10,("Found gid record %s -> %s \n", keystr, (const char *)data.dptr ));
639 } else { /* Unknown record type ! */
640 DEBUG(2, ("Found INVALID record %s -> %s\n", keystr, (const char *)data.dptr));
641 ret = NT_STATUS_INTERNAL_DB_ERROR;
645 /* apply filters before returning result */
646 if (!idmap_unix_id_is_in_range(map->xid.id, dom)) {
647 DEBUG(5, ("Requested id (%u) out of range (%u - %u). Filtered!\n",
648 map->xid.id, dom->low_id, dom->high_id));
649 ret = NT_STATUS_NONE_MAPPED;
653 talloc_free(tmp_ctx);
657 /**********************************
658 lookup a set of unix ids.
659 **********************************/
661 static NTSTATUS idmap_tdb_unixids_to_sids(struct idmap_domain *dom, struct id_map **ids)
663 struct idmap_tdb_context *ctx;
667 /* initialize the status to avoid suprise */
668 for (i = 0; ids[i]; i++) {
669 ids[i]->status = ID_UNKNOWN;
672 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
674 for (i = 0; ids[i]; i++) {
675 ret = idmap_tdb_id_to_sid(dom, ids[i]);
676 if ( ! NT_STATUS_IS_OK(ret)) {
678 /* if it is just a failed mapping continue */
679 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
681 /* make sure it is marked as unmapped */
682 ids[i]->status = ID_UNMAPPED;
686 /* some fatal error occurred, return immediately */
690 /* all ok, id is mapped */
691 ids[i]->status = ID_MAPPED;
700 /**********************************
701 lookup a set of sids.
702 **********************************/
704 static NTSTATUS idmap_tdb_sids_to_unixids(struct idmap_domain *dom, struct id_map **ids)
706 struct idmap_tdb_context *ctx;
710 /* initialize the status to avoid suprise */
711 for (i = 0; ids[i]; i++) {
712 ids[i]->status = ID_UNKNOWN;
715 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
717 for (i = 0; ids[i]; i++) {
718 ret = idmap_tdb_sid_to_id(dom, ids[i]);
719 if ( ! NT_STATUS_IS_OK(ret)) {
721 /* if it is just a failed mapping continue */
722 if (NT_STATUS_EQUAL(ret, NT_STATUS_NONE_MAPPED)) {
724 /* make sure it is marked as unmapped */
725 ids[i]->status = ID_UNMAPPED;
729 /* some fatal error occurred, return immediately */
733 /* all ok, id is mapped */
734 ids[i]->status = ID_MAPPED;
743 /**********************************
745 **********************************/
747 static NTSTATUS idmap_tdb_set_mapping(struct idmap_domain *dom,
748 const struct id_map *map)
750 struct idmap_tdb_context *ctx;
753 char *ksidstr, *kidstr;
756 if (!map || !map->sid) {
757 return NT_STATUS_INVALID_PARAMETER;
760 ksidstr = kidstr = NULL;
762 /* TODO: should we filter a set_mapping using low/high filters ? */
764 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
766 switch (map->xid.type) {
769 kidstr = talloc_asprintf(ctx, "UID %lu",
770 (unsigned long)map->xid.id);
774 kidstr = talloc_asprintf(ctx, "GID %lu",
775 (unsigned long)map->xid.id);
779 DEBUG(2, ("INVALID unix ID type: 0x02%x\n", map->xid.type));
780 return NT_STATUS_INVALID_PARAMETER;
783 if (kidstr == NULL) {
784 DEBUG(0, ("ERROR: Out of memory!\n"));
785 ret = NT_STATUS_NO_MEMORY;
789 if ((ksidstr = talloc_asprintf(
790 ctx, "%s", sid_to_fstring(tmp, map->sid))) == NULL) {
791 DEBUG(0, ("Out of memory!\n"));
792 ret = NT_STATUS_NO_MEMORY;
796 DEBUG(10, ("Storing %s <-> %s map\n", ksidstr, kidstr));
797 kid = string_term_tdb_data(kidstr);
798 ksid = string_term_tdb_data(ksidstr);
800 if (ctx->db->transaction_start(ctx->db) != 0) {
801 DEBUG(0, ("Failed to start transaction for %s\n",
803 ret = NT_STATUS_INTERNAL_DB_ERROR;
807 ret = dbwrap_store(ctx->db, ksid, kid, TDB_REPLACE);
808 if (!NT_STATUS_IS_OK(ret)) {
809 ctx->db->transaction_cancel(ctx->db);
810 DEBUG(0, ("Error storing SID -> ID (%s -> %s): %s\n",
811 ksidstr, kidstr, nt_errstr(ret)));
814 ret = dbwrap_store(ctx->db, kid, ksid, TDB_REPLACE);
815 if (!NT_STATUS_IS_OK(ret)) {
816 ctx->db->transaction_cancel(ctx->db);
817 DEBUG(0, ("Error storing ID -> SID (%s -> %s): %s\n",
818 kidstr, ksidstr, nt_errstr(ret)));
822 if (ctx->db->transaction_commit(ctx->db) != 0) {
823 DEBUG(0, ("Failed to commit transaction for (%s -> %s)\n",
825 ret = NT_STATUS_INTERNAL_DB_ERROR;
829 DEBUG(10,("Stored %s <-> %s\n", ksidstr, kidstr));
833 talloc_free(ksidstr);
838 /**********************************
839 Close the idmap tdb instance
840 **********************************/
842 static NTSTATUS idmap_tdb_close(struct idmap_domain *dom)
844 struct idmap_tdb_context *ctx;
846 if (dom->private_data) {
847 ctx = talloc_get_type(dom->private_data, struct idmap_tdb_context);
849 TALLOC_FREE(ctx->db);
854 static struct idmap_methods db_methods = {
855 .init = idmap_tdb_db_init,
856 .unixids_to_sids = idmap_tdb_unixids_to_sids,
857 .sids_to_unixids = idmap_tdb_sids_to_unixids,
858 .allocate_id = idmap_tdb_get_new_id,
859 .close_fn = idmap_tdb_close
862 NTSTATUS idmap_tdb_init(void)
864 DEBUG(10, ("calling idmap_tdb_init\n"));
866 return smb_register_idmap(SMB_IDMAP_INTERFACE_VERSION, "tdb", &db_methods);