net: rename "net idmap setmap" to "net idmap set"
[Samba.git] / source3 / utils / net_idmap.c
blob6f2efec87b43fd6cc525bfe49ac575acc520aaab
1 /*
2 Samba Unix/Linux SMB client library
3 Distributed SMB/CIFS Server Management Utility
4 Copyright (C) 2003 Andrew Bartlett (abartlet@samba.org)
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include "includes.h"
21 #include "system/filesys.h"
22 #include "utils/net.h"
23 #include "secrets.h"
24 #include "idmap.h"
25 #include "dbwrap/dbwrap.h"
26 #include "dbwrap/dbwrap_open.h"
27 #include "../libcli/security/security.h"
28 #include "net_idmap_check.h"
29 #include "util_tdb.h"
31 #define ALLOC_CHECK(mem) do { \
32 if (!mem) { \
33 d_fprintf(stderr, _("Out of memory!\n")); \
34 talloc_free(ctx); \
35 return -1; \
36 } } while(0)
38 enum idmap_dump_backend {
39 TDB,
40 AUTORID
43 struct idmap_dump_ctx {
44 enum idmap_dump_backend backend;
47 static int net_idmap_dump_one_autorid_entry(struct db_record *rec,
48 void *unused)
50 TDB_DATA key;
51 TDB_DATA value;
53 key = dbwrap_record_get_key(rec);
54 value = dbwrap_record_get_value(rec);
56 if (strncmp((char *)key.dptr, "CONFIG", 6) == 0) {
57 char *config = talloc_array(talloc_tos(), char, value.dsize+1);
58 memcpy(config, value.dptr, value.dsize);
59 config[value.dsize] = '\0';
60 printf("CONFIG: %s\n", config);
61 talloc_free(config);
62 return 0;
65 if (strncmp((char *)key.dptr, "NEXT RANGE", 10) == 0) {
66 printf("RANGE HWM: %"PRIu32"\n", IVAL(value.dptr, 0));
67 return 0;
70 if (strncmp((char *)key.dptr, "NEXT ALLOC UID", 14) == 0) {
71 printf("UID HWM: %"PRIu32"\n", IVAL(value.dptr, 0));
72 return 0;
75 if (strncmp((char *)key.dptr, "NEXT ALLOC GID", 14) == 0) {
76 printf("GID HWM: %"PRIu32"\n", IVAL(value.dptr, 0));
77 return 0;
80 if (strncmp((char *)key.dptr, "UID", 3) == 0 ||
81 strncmp((char *)key.dptr, "GID", 3) == 0)
83 /* mapped entry from allocation pool */
84 printf("%s %s\n", value.dptr, key.dptr);
85 return 0;
88 if ((strncmp((char *)key.dptr, "S-1-5-", 6) == 0 ||
89 strncmp((char *)key.dptr, "ALLOC", 5) == 0) &&
90 value.dsize == sizeof(uint32_t))
92 /* this is a domain range assignment */
93 uint32_t range = IVAL(value.dptr, 0);
94 printf("RANGE %"PRIu32": %s\n", range, key.dptr);
95 return 0;
98 return 0;
101 /***********************************************************
102 Helper function for net_idmap_dump. Dump one entry.
103 **********************************************************/
104 static int net_idmap_dump_one_tdb_entry(struct db_record *rec,
105 void *unused)
107 TDB_DATA key;
108 TDB_DATA value;
110 key = dbwrap_record_get_key(rec);
111 value = dbwrap_record_get_value(rec);
113 if (strcmp((char *)key.dptr, "USER HWM") == 0) {
114 printf(_("USER HWM %d\n"), IVAL(value.dptr,0));
115 return 0;
118 if (strcmp((char *)key.dptr, "GROUP HWM") == 0) {
119 printf(_("GROUP HWM %d\n"), IVAL(value.dptr,0));
120 return 0;
123 if (strncmp((char *)key.dptr, "S-", 2) != 0) {
124 return 0;
127 printf("%s %s\n", value.dptr, key.dptr);
128 return 0;
131 static const char* net_idmap_dbfile(struct net_context *c,
132 struct idmap_dump_ctx *ctx)
134 const char* dbfile = NULL;
135 const char *backend = NULL;
137 backend = lp_idmap_default_backend();
138 if (!backend) {
139 d_printf(_("Internal error: 'idmap config * : backend' is not set!\n"));
140 return NULL;
143 if (c->opt_db != NULL) {
144 dbfile = talloc_strdup(talloc_tos(), c->opt_db);
145 if (dbfile == NULL) {
146 d_fprintf(stderr, _("Out of memory!\n"));
148 } else if (strequal(backend, "tdb")) {
149 dbfile = state_path("winbindd_idmap.tdb");
150 if (dbfile == NULL) {
151 d_fprintf(stderr, _("Out of memory!\n"));
153 ctx->backend = TDB;
154 } else if (strequal(backend, "tdb2")) {
155 dbfile = talloc_asprintf(talloc_tos(), "%s/idmap2.tdb",
156 lp_private_dir());
157 if (dbfile == NULL) {
158 d_fprintf(stderr, _("Out of memory!\n"));
160 ctx->backend = TDB;
161 } else if (strequal(backend, "autorid")) {
162 dbfile = state_path("autorid.tdb");
163 if (dbfile == NULL) {
164 d_fprintf(stderr, _("Out of memory!\n"));
166 ctx->backend = AUTORID;
167 } else {
168 char *_backend = talloc_strdup(talloc_tos(), backend);
169 char* args = strchr(_backend, ':');
170 if (args != NULL) {
171 *args = '\0';
174 d_printf(_("Sorry, 'idmap backend = %s' is currently not supported\n"),
175 _backend);
177 talloc_free(_backend);
180 return dbfile;
183 /***********************************************************
184 Dump the current idmap
185 **********************************************************/
186 static int net_idmap_dump(struct net_context *c, int argc, const char **argv)
188 struct db_context *db;
189 TALLOC_CTX *mem_ctx;
190 const char* dbfile;
191 NTSTATUS status;
192 int ret = -1;
193 struct idmap_dump_ctx ctx = { .backend = TDB };
195 if ( argc > 1 || c->display_usage) {
196 d_printf("%s\n%s",
197 _("Usage:"),
198 _("net idmap dump [[--db=]<inputfile>]\n"
199 " Dump current ID mapping.\n"
200 " inputfile\tTDB file to read mappings from.\n"));
201 return c->display_usage?0:-1;
204 mem_ctx = talloc_stackframe();
206 dbfile = (argc > 0) ? argv[0] : net_idmap_dbfile(c, &ctx);
207 if (dbfile == NULL) {
208 goto done;
210 d_fprintf(stderr, _("dumping id mapping from %s\n"), dbfile);
212 db = db_open(mem_ctx, dbfile, 0, TDB_DEFAULT, O_RDONLY, 0,
213 DBWRAP_LOCK_ORDER_1);
214 if (db == NULL) {
215 d_fprintf(stderr, _("Could not open idmap db (%s): %s\n"),
216 dbfile, strerror(errno));
217 goto done;
220 if (ctx.backend == AUTORID) {
221 status = dbwrap_traverse_read(db,
222 net_idmap_dump_one_autorid_entry,
223 NULL, NULL);
224 } else {
225 status = dbwrap_traverse_read(db,
226 net_idmap_dump_one_tdb_entry,
227 NULL, NULL);
229 if (!NT_STATUS_IS_OK(status)) {
230 d_fprintf(stderr, _("error traversing the database\n"));
231 ret = -1;
232 goto done;
235 ret = 0;
237 done:
238 talloc_free(mem_ctx);
239 return ret;
242 /***********************************************************
243 Write entries from stdin to current local idmap
244 **********************************************************/
246 static int net_idmap_store_id_mapping(struct db_context *db,
247 enum id_type type,
248 unsigned long idval,
249 const char *sid_string)
251 NTSTATUS status;
252 char *idstr = NULL;
254 switch(type) {
255 case ID_TYPE_UID:
256 idstr = talloc_asprintf(talloc_tos(), "UID %lu", idval);
257 break;
258 case ID_TYPE_GID:
259 idstr = talloc_asprintf(talloc_tos(), "GID %lu", idval);
260 break;
261 default:
262 d_fprintf(stderr, "Invalid id mapping type: %d\n", type);
263 return -1;
266 status = dbwrap_store_bystring(db, idstr,
267 string_term_tdb_data(sid_string),
268 TDB_REPLACE);
269 if (!NT_STATUS_IS_OK(status)) {
270 d_fprintf(stderr, "Error storing ID -> SID: "
271 "%s\n", nt_errstr(status));
272 talloc_free(idstr);
273 return -1;
275 status = dbwrap_store_bystring(db, sid_string,
276 string_term_tdb_data(idstr),
277 TDB_REPLACE);
278 if (!NT_STATUS_IS_OK(status)) {
279 d_fprintf(stderr, "Error storing SID -> ID: "
280 "%s\n", nt_errstr(status));
281 talloc_free(idstr);
282 return -1;
285 return 0;
288 static int net_idmap_restore(struct net_context *c, int argc, const char **argv)
290 TALLOC_CTX *mem_ctx;
291 FILE *input = NULL;
292 struct db_context *db;
293 const char *dbfile = NULL;
294 int ret = 0;
295 struct idmap_dump_ctx ctx = { .backend = TDB };
297 if (c->display_usage) {
298 d_printf("%s\n%s",
299 _("Usage:"),
300 _("net idmap restore [--db=<TDB>] [<inputfile>]\n"
301 " Restore ID mappings from file\n"
302 " TDB\tFile to store ID mappings to."
303 " inputfile\tFile to load ID mappings from. If not "
304 "given, load data from stdin.\n"));
305 return 0;
308 mem_ctx = talloc_stackframe();
310 dbfile = net_idmap_dbfile(c, &ctx);
312 if (dbfile == NULL) {
313 ret = -1;
314 goto done;
317 if (ctx.backend != TDB) {
318 d_fprintf(stderr, _("Sorry, restoring of non-TDB databases is "
319 "currently not supported\n"));
320 ret = -1;
321 goto done;
324 d_fprintf(stderr, _("restoring id mapping to %s\n"), dbfile);
326 if (argc == 1) {
327 input = fopen(argv[0], "r");
328 if (input == NULL) {
329 d_fprintf(stderr, _("Could not open input file (%s): %s\n"),
330 argv[0], strerror(errno));
331 ret = -1;
332 goto done;
334 } else {
335 input = stdin;
338 db = db_open(mem_ctx, dbfile, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0644,
339 DBWRAP_LOCK_ORDER_1);
340 if (db == NULL) {
341 d_fprintf(stderr, _("Could not open idmap db (%s): %s\n"),
342 dbfile, strerror(errno));
343 ret = -1;
344 goto done;
347 if (dbwrap_transaction_start(db) != 0) {
348 d_fprintf(stderr, _("Failed to start transaction.\n"));
349 ret = -1;
350 goto done;
353 while (!feof(input)) {
354 char line[128], sid_string[128];
355 int len;
356 unsigned long idval;
357 NTSTATUS status;
359 if (fgets(line, 127, input) == NULL)
360 break;
362 len = strlen(line);
364 if ( (len > 0) && (line[len-1] == '\n') )
365 line[len-1] = '\0';
367 if (sscanf(line, "GID %lu %128s", &idval, sid_string) == 2)
369 ret = net_idmap_store_id_mapping(db, ID_TYPE_GID,
370 idval, sid_string);
371 if (ret != 0) {
372 break;
374 } else if (sscanf(line, "UID %lu %128s", &idval, sid_string) == 2)
376 ret = net_idmap_store_id_mapping(db, ID_TYPE_UID,
377 idval, sid_string);
378 if (ret != 0) {
379 break;
381 } else if (sscanf(line, "USER HWM %lu", &idval) == 1) {
382 status = dbwrap_store_int32_bystring(
383 db, "USER HWM", idval);
384 if (!NT_STATUS_IS_OK(status)) {
385 d_fprintf(stderr,
386 _("Could not store USER HWM: %s\n"),
387 nt_errstr(status));
388 break;
390 } else if (sscanf(line, "GROUP HWM %lu", &idval) == 1) {
391 status = dbwrap_store_int32_bystring(
392 db, "GROUP HWM", idval);
393 if (!NT_STATUS_IS_OK(status)) {
394 d_fprintf(stderr,
395 _("Could not store GROUP HWM: %s\n"),
396 nt_errstr(status));
397 break;
399 } else {
400 d_fprintf(stderr, _("ignoring invalid line [%s]\n"),
401 line);
402 continue;
406 if (ret == 0) {
407 if(dbwrap_transaction_commit(db) != 0) {
408 d_fprintf(stderr, _("Failed to commit transaction.\n"));
409 ret = -1;
411 } else {
412 if (dbwrap_transaction_cancel(db) != 0) {
413 d_fprintf(stderr, _("Failed to cancel transaction.\n"));
417 done:
418 if ((input != NULL) && (input != stdin)) {
419 fclose(input);
422 talloc_free(mem_ctx);
423 return ret;
426 static
427 NTSTATUS dbwrap_delete_mapping(struct db_context *db, TDB_DATA key1, bool force)
429 TALLOC_CTX *mem_ctx = talloc_stackframe();
430 bool is_valid_mapping;
431 NTSTATUS status = NT_STATUS_OK;
432 TDB_DATA val1, val2;
434 ZERO_STRUCT(val1);
435 ZERO_STRUCT(val2);
437 status = dbwrap_fetch(db, mem_ctx, key1, &val1);
438 if (!NT_STATUS_IS_OK(status)) {
439 DEBUG(1, ("failed to fetch: %.*s\n", (int)key1.dsize, key1.dptr));
440 goto done;
443 if (val1.dptr == NULL) {
444 DEBUG(1, ("invalid mapping: %.*s -> empty value\n",
445 (int)key1.dsize, key1.dptr));
446 status = NT_STATUS_FILE_INVALID;
447 goto done;
450 DEBUG(2, ("mapping: %.*s -> %.*s\n",
451 (int)key1.dsize, key1.dptr, (int)val1.dsize, val1.dptr));
453 status = dbwrap_fetch(db, mem_ctx, val1, &val2);
454 if (!NT_STATUS_IS_OK(status)) {
455 DEBUG(1, ("failed to fetch: %.*s\n", (int)val1.dsize, val1.dptr));
456 goto done;
459 is_valid_mapping = tdb_data_equal(key1, val2);
461 if (!is_valid_mapping) {
462 DEBUG(1, ("invalid mapping: %.*s -> %.*s -> %.*s\n",
463 (int)key1.dsize, key1.dptr,
464 (int)val1.dsize, val1.dptr,
465 (int)val2.dsize, val2.dptr));
466 if ( !force ) {
467 status = NT_STATUS_FILE_INVALID;
468 goto done;
472 status = dbwrap_delete(db, key1);
473 if (!NT_STATUS_IS_OK(status)) {
474 DEBUG(1, ("failed to delete: %.*s\n", (int)key1.dsize, key1.dptr));
475 goto done;
478 if (!is_valid_mapping) {
479 goto done;
482 status = dbwrap_delete(db, val1);
483 if (!NT_STATUS_IS_OK(status)) {
484 DEBUG(1, ("failed to delete: %.*s\n", (int)val1.dsize, val1.dptr));
487 done:
488 talloc_free(mem_ctx);
489 return status;
492 static
493 NTSTATUS delete_mapping_action(struct db_context *db, void* data)
495 return dbwrap_delete_mapping(db, *(TDB_DATA*)data, false);
497 static
498 NTSTATUS delete_mapping_action_force(struct db_context *db, void* data)
500 return dbwrap_delete_mapping(db, *(TDB_DATA*)data, true);
503 /***********************************************************
504 Delete a SID mapping from a winbindd_idmap.tdb
505 **********************************************************/
506 static bool delete_args_ok(int argc, const char **argv)
508 if (argc != 1)
509 return false;
510 if (strncmp(argv[0], "S-", 2) == 0)
511 return true;
512 if (strncmp(argv[0], "GID ", 4) == 0)
513 return true;
514 if (strncmp(argv[0], "UID ", 4) == 0)
515 return true;
516 return false;
519 static int net_idmap_delete(struct net_context *c, int argc, const char **argv)
521 int ret = -1;
522 struct db_context *db;
523 TALLOC_CTX *mem_ctx;
524 TDB_DATA key;
525 NTSTATUS status;
526 const char* dbfile;
527 struct idmap_dump_ctx ctx = { .backend = TDB };
529 if ( !delete_args_ok(argc,argv) || c->display_usage) {
530 d_printf("%s\n%s",
531 _("Usage:"),
532 _("net idmap delete [-f] [--db=<TDB>] <ID>\n"
533 " Delete mapping of ID from TDB.\n"
534 " -f\tforce\n"
535 " TDB\tidmap database\n"
536 " ID\tSID|GID|UID\n"));
537 return c->display_usage ? 0 : -1;
540 mem_ctx = talloc_stackframe();
542 dbfile = net_idmap_dbfile(c, &ctx);
543 if (dbfile == NULL) {
544 goto done;
546 d_fprintf(stderr, _("deleting id mapping from %s\n"), dbfile);
548 db = db_open(mem_ctx, dbfile, 0, TDB_DEFAULT, O_RDWR, 0,
549 DBWRAP_LOCK_ORDER_1);
550 if (db == NULL) {
551 d_fprintf(stderr, _("Could not open idmap db (%s): %s\n"),
552 dbfile, strerror(errno));
553 goto done;
556 key = string_term_tdb_data(argv[0]);
558 status = dbwrap_trans_do(db, (c->opt_force
559 ? delete_mapping_action_force
560 : delete_mapping_action), &key);
562 if (!NT_STATUS_IS_OK(status)) {
563 d_fprintf(stderr, _("could not delete mapping: %s\n"),
564 nt_errstr(status));
565 goto done;
567 ret = 0;
568 done:
569 talloc_free(mem_ctx);
570 return ret;
573 static int net_idmap_set(struct net_context *c, int argc, const char **argv)
575 d_printf("%s\n", _("Not implemented yet"));
576 return -1;
579 static bool idmap_store_secret(const char *backend,
580 const char *domain,
581 const char *identity,
582 const char *secret)
584 char *tmp;
585 int r;
586 bool ret;
588 r = asprintf(&tmp, "IDMAP_%s_%s", backend, domain);
590 if (r < 0) return false;
592 /* make sure the key is case insensitive */
593 if (!strupper_m(tmp)) {
594 free(tmp);
595 return false;
597 ret = secrets_store_generic(tmp, identity, secret);
599 free(tmp);
600 return ret;
604 static int net_idmap_secret(struct net_context *c, int argc, const char **argv)
606 TALLOC_CTX *ctx;
607 const char *secret;
608 const char *dn;
609 char *domain;
610 char *backend;
611 char *opt = NULL;
612 bool ret;
614 if (argc != 2 || c->display_usage) {
615 d_printf("%s\n%s",
616 _("Usage:\n"),
617 _("net idmap secret <DOMAIN> <secret>\n"
618 " Set the secret for the specified domain\n"
619 " DOMAIN\tDomain to set secret for.\n"
620 " secret\tNew secret to set.\n"));
621 return c->display_usage?0:-1;
624 secret = argv[1];
626 ctx = talloc_new(NULL);
627 ALLOC_CHECK(ctx);
629 domain = talloc_strdup(ctx, argv[0]);
630 ALLOC_CHECK(domain);
632 opt = talloc_asprintf(ctx, "idmap config %s", domain);
633 ALLOC_CHECK(opt);
635 backend = talloc_strdup(ctx, lp_parm_const_string(-1, opt, "backend", "tdb"));
636 ALLOC_CHECK(backend);
638 if ((!backend) || (!strequal(backend, "ldap") &&
639 !strequal(backend, "rfc2307"))) {
640 d_fprintf(stderr,
641 _("The only currently supported backend are LDAP "
642 "and rfc2307\n"));
643 talloc_free(ctx);
644 return -1;
647 dn = lp_parm_const_string(-1, opt, "ldap_user_dn", NULL);
648 if ( ! dn) {
649 d_fprintf(stderr,
650 _("Missing ldap_user_dn option for domain %s\n"),
651 domain);
652 talloc_free(ctx);
653 return -1;
656 ret = idmap_store_secret("ldap", domain, dn, secret);
658 if ( ! ret) {
659 d_fprintf(stderr, _("Failed to store secret\n"));
660 talloc_free(ctx);
661 return -1;
664 d_printf(_("Secret stored\n"));
665 return 0;
668 static int net_idmap_check(struct net_context *c, int argc, const char **argv)
670 const char* dbfile;
671 struct check_options opts;
672 struct idmap_dump_ctx ctx = { .backend = TDB };
674 if ( argc > 1 || c->display_usage) {
675 d_printf("%s\n%s",
676 _("Usage:"),
677 _("net idmap check [-v] [-r] [-a] [-T] [-f] [-l] [[--db=]<TDB>]\n"
678 " Check an idmap database.\n"
679 " --verbose,-v\tverbose\n"
680 " --repair,-r\trepair\n"
681 " --auto,-a\tnoninteractive mode\n"
682 " --test,-T\tdry run\n"
683 " --fore,-f\tforce\n"
684 " --lock,-l\tlock db while doing the check\n"
685 " TDB\tidmap database\n"));
686 return c->display_usage ? 0 : -1;
689 dbfile = (argc > 0) ? argv[0] : net_idmap_dbfile(c, &ctx);
690 if (dbfile == NULL) {
691 return -1;
694 if (ctx.backend != TDB) {
695 d_fprintf(stderr, _("Sorry, checking of non-TDB databases is "
696 "currently not supported\n"));
697 return -1;
700 d_fprintf(stderr, _("check database: %s\n"), dbfile);
702 opts = (struct check_options) {
703 .lock = c->opt_lock || c->opt_long_list_entries,
704 .test = c->opt_testmode,
705 .automatic = c->opt_auto,
706 .verbose = c->opt_verbose,
707 .force = c->opt_force,
708 .repair = c->opt_repair || c->opt_reboot,
711 return net_idmap_check_db(dbfile, &opts);
714 /***********************************************************
715 Look at the current idmap
716 **********************************************************/
717 int net_idmap(struct net_context *c, int argc, const char **argv)
719 struct functable func[] = {
721 "dump",
722 net_idmap_dump,
723 NET_TRANSPORT_LOCAL,
724 N_("Dump the current ID mapping database"),
725 N_("net idmap dump\n"
726 " Dump the current ID mappings")
729 "restore",
730 net_idmap_restore,
731 NET_TRANSPORT_LOCAL,
732 N_("Restore entries from a file or stdin"),
733 N_("net idmap restore\n"
734 " Restore entries from stdin")
737 "set",
738 net_idmap_set,
739 NET_TRANSPORT_LOCAL,
740 N_("Not implemented yet"),
741 N_("net idmap set\n"
742 " Not implemented yet")
745 "delete",
746 net_idmap_delete,
747 NET_TRANSPORT_LOCAL,
748 N_("Delete ID mapping"),
749 N_("net idmap delete <ID>\n"
750 " Delete ID mapping")
753 "secret",
754 net_idmap_secret,
755 NET_TRANSPORT_LOCAL,
756 N_("Set secret for specified domain"),
757 N_("net idmap secret <DOMAIN> <secret>\n"
758 " Set secret for specified domain")
761 "check",
762 net_idmap_check,
763 NET_TRANSPORT_LOCAL,
764 N_("Check id mappings"),
765 N_("net idmap check\n"
766 " Check id mappings")
768 {NULL, NULL, 0, NULL, NULL}
771 return net_run_function(c, argc, argv, "net idmap", func);