docs: Add very basic samba manpage.
[Samba/gebeck_regimport.git] / source3 / utils / net_idmap.c
blobebc14e528dea965778d3a46f5625bab7796816e9
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 /***********************************************************
39 Helper function for net_idmap_dump. Dump one entry.
40 **********************************************************/
41 static int net_idmap_dump_one_entry(struct db_record *rec,
42 void *unused)
44 TDB_DATA key;
45 TDB_DATA value;
47 key = dbwrap_record_get_key(rec);
48 value = dbwrap_record_get_value(rec);
50 if (strcmp((char *)key.dptr, "USER HWM") == 0) {
51 printf(_("USER HWM %d\n"), IVAL(value.dptr,0));
52 return 0;
55 if (strcmp((char *)key.dptr, "GROUP HWM") == 0) {
56 printf(_("GROUP HWM %d\n"), IVAL(value.dptr,0));
57 return 0;
60 if (strncmp((char *)key.dptr, "S-", 2) != 0)
61 return 0;
63 printf("%s %s\n", value.dptr, key.dptr);
64 return 0;
67 static const char* net_idmap_dbfile(struct net_context *c)
69 const char* dbfile = NULL;
71 if (c->opt_db != NULL) {
72 dbfile = talloc_strdup(talloc_tos(), c->opt_db);
73 if (dbfile == NULL) {
74 d_fprintf(stderr, _("Out of memory!\n"));
76 } else if (strequal(lp_idmap_backend(), "tdb")) {
77 dbfile = state_path("winbindd_idmap.tdb");
78 if (dbfile == NULL) {
79 d_fprintf(stderr, _("Out of memory!\n"));
81 } else if (strequal(lp_idmap_backend(), "tdb2")) {
82 dbfile = lp_parm_talloc_string(talloc_tos(),
83 -1, "tdb", "idmap2.tdb", NULL);
84 if (dbfile == NULL) {
85 dbfile = talloc_asprintf(talloc_tos(), "%s/idmap2.tdb",
86 lp_private_dir());
88 if (dbfile == NULL) {
89 d_fprintf(stderr, _("Out of memory!\n"));
91 } else {
92 char* backend = talloc_strdup(talloc_tos(), lp_idmap_backend());
93 char* args = strchr(backend, ':');
94 if (args != NULL) {
95 *args = '\0';
98 d_printf(_("Sorry, 'idmap backend = %s' is currently not supported\n"),
99 backend);
101 talloc_free(backend);
104 return dbfile;
107 /***********************************************************
108 Dump the current idmap
109 **********************************************************/
110 static int net_idmap_dump(struct net_context *c, int argc, const char **argv)
112 struct db_context *db;
113 TALLOC_CTX *mem_ctx;
114 const char* dbfile;
115 NTSTATUS status;
116 int ret = -1;
118 if ( argc > 1 || c->display_usage) {
119 d_printf("%s\n%s",
120 _("Usage:"),
121 _("net idmap dump [[--db=]<inputfile>]\n"
122 " Dump current ID mapping.\n"
123 " inputfile\tTDB file to read mappings from.\n"));
124 return c->display_usage?0:-1;
127 mem_ctx = talloc_stackframe();
129 dbfile = (argc > 0) ? argv[0] : net_idmap_dbfile(c);
130 if (dbfile == NULL) {
131 goto done;
133 d_fprintf(stderr, _("dumping id mapping from %s\n"), dbfile);
135 db = db_open(mem_ctx, dbfile, 0, TDB_DEFAULT, O_RDONLY, 0,
136 DBWRAP_LOCK_ORDER_1);
137 if (db == NULL) {
138 d_fprintf(stderr, _("Could not open idmap db (%s): %s\n"),
139 dbfile, strerror(errno));
140 goto done;
143 status = dbwrap_traverse_read(db, net_idmap_dump_one_entry, NULL, NULL);
144 if (!NT_STATUS_IS_OK(status)) {
145 d_fprintf(stderr, _("error traversing the database\n"));
146 ret = -1;
147 goto done;
150 ret = 0;
152 done:
153 talloc_free(mem_ctx);
154 return ret;
157 /***********************************************************
158 Write entries from stdin to current local idmap
159 **********************************************************/
161 static int net_idmap_store_id_mapping(struct db_context *db,
162 enum id_type type,
163 unsigned long idval,
164 const char *sid_string)
166 NTSTATUS status;
167 char *idstr = NULL;
169 switch(type) {
170 case ID_TYPE_UID:
171 idstr = talloc_asprintf(talloc_tos(), "UID %lu", idval);
172 break;
173 case ID_TYPE_GID:
174 idstr = talloc_asprintf(talloc_tos(), "GID %lu", idval);
175 break;
176 default:
177 d_fprintf(stderr, "Invalid id mapping type: %d\n", type);
178 return -1;
181 status = dbwrap_store_bystring(db, idstr,
182 string_term_tdb_data(sid_string),
183 TDB_REPLACE);
184 if (!NT_STATUS_IS_OK(status)) {
185 d_fprintf(stderr, "Error storing ID -> SID: "
186 "%s\n", nt_errstr(status));
187 talloc_free(idstr);
188 return -1;
190 status = dbwrap_store_bystring(db, sid_string,
191 string_term_tdb_data(idstr),
192 TDB_REPLACE);
193 if (!NT_STATUS_IS_OK(status)) {
194 d_fprintf(stderr, "Error storing SID -> ID: "
195 "%s\n", nt_errstr(status));
196 talloc_free(idstr);
197 return -1;
200 return 0;
203 static int net_idmap_restore(struct net_context *c, int argc, const char **argv)
205 TALLOC_CTX *mem_ctx;
206 FILE *input = NULL;
207 struct db_context *db;
208 const char *dbfile = NULL;
209 int ret = 0;
211 if (c->display_usage) {
212 d_printf("%s\n%s",
213 _("Usage:"),
214 _("net idmap restore [--db=<TDB>] [<inputfile>]\n"
215 " Restore ID mappings from file\n"
216 " TDB\tFile to store ID mappings to."
217 " inputfile\tFile to load ID mappings from. If not "
218 "given, load data from stdin.\n"));
219 return 0;
222 mem_ctx = talloc_stackframe();
224 dbfile = net_idmap_dbfile(c);
226 if (dbfile == NULL) {
227 ret = -1;
228 goto done;
231 d_fprintf(stderr, _("restoring id mapping to %s\n"), dbfile);
233 if (argc == 1) {
234 input = fopen(argv[0], "r");
235 if (input == NULL) {
236 d_fprintf(stderr, _("Could not open input file (%s): %s\n"),
237 argv[0], strerror(errno));
238 ret = -1;
239 goto done;
241 } else {
242 input = stdin;
245 db = db_open(mem_ctx, dbfile, 0, TDB_DEFAULT, O_RDWR|O_CREAT, 0644,
246 DBWRAP_LOCK_ORDER_1);
247 if (db == NULL) {
248 d_fprintf(stderr, _("Could not open idmap db (%s): %s\n"),
249 dbfile, strerror(errno));
250 ret = -1;
251 goto done;
254 if (dbwrap_transaction_start(db) != 0) {
255 d_fprintf(stderr, _("Failed to start transaction.\n"));
256 ret = -1;
257 goto done;
260 while (!feof(input)) {
261 char line[128], sid_string[128];
262 int len;
263 unsigned long idval;
264 NTSTATUS status;
266 if (fgets(line, 127, input) == NULL)
267 break;
269 len = strlen(line);
271 if ( (len > 0) && (line[len-1] == '\n') )
272 line[len-1] = '\0';
274 if (sscanf(line, "GID %lu %128s", &idval, sid_string) == 2)
276 ret = net_idmap_store_id_mapping(db, ID_TYPE_GID,
277 idval, sid_string);
278 if (ret != 0) {
279 break;
281 } else if (sscanf(line, "UID %lu %128s", &idval, sid_string) == 2)
283 ret = net_idmap_store_id_mapping(db, ID_TYPE_UID,
284 idval, sid_string);
285 if (ret != 0) {
286 break;
288 } else if (sscanf(line, "USER HWM %lu", &idval) == 1) {
289 status = dbwrap_store_int32_bystring(
290 db, "USER HWM", idval);
291 if (!NT_STATUS_IS_OK(status)) {
292 d_fprintf(stderr,
293 _("Could not store USER HWM: %s\n"),
294 nt_errstr(status));
295 break;
297 } else if (sscanf(line, "GROUP HWM %lu", &idval) == 1) {
298 status = dbwrap_store_int32_bystring(
299 db, "GROUP HWM", idval);
300 if (!NT_STATUS_IS_OK(status)) {
301 d_fprintf(stderr,
302 _("Could not store GROUP HWM: %s\n"),
303 nt_errstr(status));
304 break;
306 } else {
307 d_fprintf(stderr, _("ignoring invalid line [%s]\n"),
308 line);
309 continue;
313 if (ret == 0) {
314 if(dbwrap_transaction_commit(db) != 0) {
315 d_fprintf(stderr, _("Failed to commit transaction.\n"));
316 ret = -1;
318 } else {
319 if (dbwrap_transaction_cancel(db) != 0) {
320 d_fprintf(stderr, _("Failed to cancel transaction.\n"));
324 done:
325 if ((input != NULL) && (input != stdin)) {
326 fclose(input);
329 talloc_free(mem_ctx);
330 return ret;
333 static
334 NTSTATUS dbwrap_delete_mapping(struct db_context *db, TDB_DATA key1, bool force)
336 TALLOC_CTX* mem_ctx = talloc_tos();
337 struct db_record *rec1=NULL, *rec2=NULL;
338 TDB_DATA key2;
339 bool is_valid_mapping;
340 NTSTATUS status = NT_STATUS_OK;
341 TDB_DATA value;
343 rec1 = dbwrap_fetch_locked(db, mem_ctx, key1);
344 if (rec1 == NULL) {
345 DEBUG(1, ("failed to fetch: %.*s\n", (int)key1.dsize, key1.dptr));
346 status = NT_STATUS_NO_MEMORY;
347 goto done;
349 key2 = dbwrap_record_get_value(rec1);
350 if (key2.dptr == NULL) {
351 DEBUG(1, ("could not find %.*s\n", (int)key1.dsize, key1.dptr));
352 status = NT_STATUS_NOT_FOUND;
353 goto done;
356 DEBUG(2, ("mapping: %.*s -> %.*s\n",
357 (int)key1.dsize, key1.dptr, (int)key2.dsize, key2.dptr));
359 rec2 = dbwrap_fetch_locked(db, mem_ctx, key2);
360 if (rec2 == NULL) {
361 DEBUG(1, ("failed to fetch: %.*s\n", (int)key2.dsize, key2.dptr));
362 status = NT_STATUS_NO_MEMORY;
363 goto done;
366 value = dbwrap_record_get_value(rec2);
367 is_valid_mapping = tdb_data_equal(key1, value);
369 if (!is_valid_mapping) {
370 DEBUG(1, ("invalid mapping: %.*s -> %.*s -> %.*s\n",
371 (int)key1.dsize, key1.dptr, (int)key2.dsize, key2.dptr,
372 (int)value.dsize, value.dptr ));
373 if ( !force ) {
374 status = NT_STATUS_FILE_INVALID;
375 goto done;
379 status = dbwrap_record_delete(rec1);
380 if (!NT_STATUS_IS_OK(status)) {
381 DEBUG(1, ("failed to delete: %.*s\n", (int)key1.dsize, key1.dptr));
382 goto done;
385 if (is_valid_mapping) {
386 status = dbwrap_record_delete(rec2);
387 if (!NT_STATUS_IS_OK(status)) {
388 DEBUG(1, ("failed to delete: %.*s\n", (int)key2.dsize, key2.dptr));
391 done:
392 TALLOC_FREE(rec1);
393 TALLOC_FREE(rec2);
394 return status;
397 static
398 NTSTATUS delete_mapping_action(struct db_context *db, void* data)
400 return dbwrap_delete_mapping(db, *(TDB_DATA*)data, false);
402 static
403 NTSTATUS delete_mapping_action_force(struct db_context *db, void* data)
405 return dbwrap_delete_mapping(db, *(TDB_DATA*)data, true);
408 /***********************************************************
409 Delete a SID mapping from a winbindd_idmap.tdb
410 **********************************************************/
411 static bool delete_args_ok(int argc, const char **argv)
413 if (argc != 1)
414 return false;
415 if (strncmp(argv[0], "S-", 2) == 0)
416 return true;
417 if (strncmp(argv[0], "GID ", 4) == 0)
418 return true;
419 if (strncmp(argv[0], "UID ", 4) == 0)
420 return true;
421 return false;
424 static int net_idmap_delete(struct net_context *c, int argc, const char **argv)
426 int ret = -1;
427 struct db_context *db;
428 TALLOC_CTX *mem_ctx;
429 TDB_DATA key;
430 NTSTATUS status;
431 const char* dbfile;
433 if ( !delete_args_ok(argc,argv) || c->display_usage) {
434 d_printf("%s\n%s",
435 _("Usage:"),
436 _("net idmap delete [-f] [--db=<TDB>] <ID>\n"
437 " Delete mapping of ID from TDB.\n"
438 " -f\tforce\n"
439 " TDB\tidmap database\n"
440 " ID\tSID|GID|UID\n"));
441 return c->display_usage ? 0 : -1;
444 mem_ctx = talloc_stackframe();
446 dbfile = net_idmap_dbfile(c);
447 if (dbfile == NULL) {
448 goto done;
450 d_fprintf(stderr, _("deleting id mapping from %s\n"), dbfile);
452 db = db_open(mem_ctx, dbfile, 0, TDB_DEFAULT, O_RDWR, 0,
453 DBWRAP_LOCK_ORDER_1);
454 if (db == NULL) {
455 d_fprintf(stderr, _("Could not open idmap db (%s): %s\n"),
456 dbfile, strerror(errno));
457 goto done;
460 key = string_term_tdb_data(argv[0]);
462 status = dbwrap_trans_do(db, (c->opt_force
463 ? delete_mapping_action_force
464 : delete_mapping_action), &key);
466 if (!NT_STATUS_IS_OK(status)) {
467 d_fprintf(stderr, _("could not delete mapping: %s\n"),
468 nt_errstr(status));
469 goto done;
471 ret = 0;
472 done:
473 talloc_free(mem_ctx);
474 return ret;
477 static int net_idmap_set(struct net_context *c, int argc, const char **argv)
479 d_printf("%s\n", _("Not implemented yet"));
480 return -1;
482 static bool idmap_store_secret(const char *backend,
483 const char *domain,
484 const char *identity,
485 const char *secret)
487 char *tmp;
488 int r;
489 bool ret;
491 r = asprintf(&tmp, "IDMAP_%s_%s", backend, domain);
493 if (r < 0) return false;
495 /* make sure the key is case insensitive */
496 if (!strupper_m(tmp)) {
497 free(tmp);
498 return false;
500 ret = secrets_store_generic(tmp, identity, secret);
502 free(tmp);
503 return ret;
507 static int net_idmap_secret(struct net_context *c, int argc, const char **argv)
509 TALLOC_CTX *ctx;
510 const char *secret;
511 const char *dn;
512 char *domain;
513 char *backend;
514 char *opt = NULL;
515 bool ret;
517 if (argc != 2 || c->display_usage) {
518 d_printf("%s\n%s",
519 _("Usage:\n"),
520 _("net idmap secret <DOMAIN> <secret>\n"
521 " Set the secret for the specified domain\n"
522 " DOMAIN\tDomain to set secret for.\n"
523 " secret\tNew secret to set.\n"));
524 return c->display_usage?0:-1;
527 secret = argv[1];
529 ctx = talloc_new(NULL);
530 ALLOC_CHECK(ctx);
532 domain = talloc_strdup(ctx, argv[0]);
533 ALLOC_CHECK(domain);
535 opt = talloc_asprintf(ctx, "idmap config %s", domain);
536 ALLOC_CHECK(opt);
538 backend = talloc_strdup(ctx, lp_parm_const_string(-1, opt, "backend", "tdb"));
539 ALLOC_CHECK(backend);
541 if ( ( ! backend) || ( ! strequal(backend, "ldap"))) {
542 d_fprintf(stderr,
543 _("The only currently supported backend is LDAP\n"));
544 talloc_free(ctx);
545 return -1;
548 dn = lp_parm_const_string(-1, opt, "ldap_user_dn", NULL);
549 if ( ! dn) {
550 d_fprintf(stderr,
551 _("Missing ldap_user_dn option for domain %s\n"),
552 domain);
553 talloc_free(ctx);
554 return -1;
557 ret = idmap_store_secret("ldap", domain, dn, secret);
559 if ( ! ret) {
560 d_fprintf(stderr, _("Failed to store secret\n"));
561 talloc_free(ctx);
562 return -1;
565 d_printf(_("Secret stored\n"));
566 return 0;
569 static int net_idmap_check(struct net_context *c, int argc, const char **argv)
571 const char* dbfile;
572 struct check_options opts;
574 if ( argc > 1 || c->display_usage) {
575 d_printf("%s\n%s",
576 _("Usage:"),
577 _("net idmap check [-v] [-r] [-a] [-T] [-f] [-l] [[--db=]<TDB>]\n"
578 " Check an idmap database.\n"
579 " --verbose,-v\tverbose\n"
580 " --repair,-r\trepair\n"
581 " --auto,-a\tnoninteractive mode\n"
582 " --test,-T\tdry run\n"
583 " --fore,-f\tforce\n"
584 " --lock,-l\tlock db while doing the check\n"
585 " TDB\tidmap database\n"));
586 return c->display_usage ? 0 : -1;
589 dbfile = (argc > 0) ? argv[0] : net_idmap_dbfile(c);
590 if (dbfile == NULL) {
591 return -1;
593 d_fprintf(stderr, _("check database: %s\n"), dbfile);
595 opts = (struct check_options) {
596 .lock = c->opt_lock || c->opt_long_list_entries,
597 .test = c->opt_testmode,
598 .automatic = c->opt_auto,
599 .verbose = c->opt_verbose,
600 .force = c->opt_force,
601 .repair = c->opt_repair || c->opt_reboot,
604 return net_idmap_check_db(dbfile, &opts);
607 static int net_idmap_aclmapset(struct net_context *c, int argc, const char **argv)
609 TALLOC_CTX *mem_ctx;
610 int result = -1;
611 struct dom_sid src_sid, dst_sid;
612 char *src, *dst;
613 struct db_context *db;
614 struct db_record *rec;
615 NTSTATUS status;
617 if (argc != 3 || c->display_usage) {
618 d_fprintf(stderr, "%s net idmap aclmapset <tdb> "
619 "<src-sid> <dst-sid>\n", _("Usage:"));
620 return -1;
623 if (!(mem_ctx = talloc_init("net idmap aclmapset"))) {
624 d_fprintf(stderr, _("talloc_init failed\n"));
625 return -1;
628 if (!(db = db_open(mem_ctx, argv[0], 0, TDB_DEFAULT,
629 O_RDWR|O_CREAT, 0600,
630 DBWRAP_LOCK_ORDER_1))) {
631 d_fprintf(stderr, _("db_open failed: %s\n"), strerror(errno));
632 goto fail;
635 if (!string_to_sid(&src_sid, argv[1])) {
636 d_fprintf(stderr, _("%s is not a valid sid\n"), argv[1]);
637 goto fail;
640 if (!string_to_sid(&dst_sid, argv[2])) {
641 d_fprintf(stderr, _("%s is not a valid sid\n"), argv[2]);
642 goto fail;
645 if (!(src = sid_string_talloc(mem_ctx, &src_sid))
646 || !(dst = sid_string_talloc(mem_ctx, &dst_sid))) {
647 d_fprintf(stderr, _("talloc_strdup failed\n"));
648 goto fail;
651 if (!(rec = dbwrap_fetch_locked(
652 db, mem_ctx, string_term_tdb_data(src)))) {
653 d_fprintf(stderr, _("could not fetch db record\n"));
654 goto fail;
657 status = dbwrap_record_store(rec, string_term_tdb_data(dst), 0);
658 TALLOC_FREE(rec);
660 if (!NT_STATUS_IS_OK(status)) {
661 d_fprintf(stderr, _("could not store record: %s\n"),
662 nt_errstr(status));
663 goto fail;
666 result = 0;
667 fail:
668 TALLOC_FREE(mem_ctx);
669 return result;
672 /***********************************************************
673 Look at the current idmap
674 **********************************************************/
675 int net_idmap(struct net_context *c, int argc, const char **argv)
677 struct functable func[] = {
679 "dump",
680 net_idmap_dump,
681 NET_TRANSPORT_LOCAL,
682 N_("Dump the current ID mappings"),
683 N_("net idmap dump\n"
684 " Dump the current ID mappings")
687 "restore",
688 net_idmap_restore,
689 NET_TRANSPORT_LOCAL,
690 N_("Restore entries from stdin"),
691 N_("net idmap restore\n"
692 " Restore entries from stdin")
695 "setmap",
696 net_idmap_set,
697 NET_TRANSPORT_LOCAL,
698 N_("Not implemented yet"),
699 N_("net idmap setmap\n"
700 " Not implemented yet")
703 "delete",
704 net_idmap_delete,
705 NET_TRANSPORT_LOCAL,
706 N_("Delete ID mapping"),
707 N_("net idmap delete <ID>\n"
708 " Delete ID mapping")
711 "secret",
712 net_idmap_secret,
713 NET_TRANSPORT_LOCAL,
714 N_("Set secret for specified domain"),
715 N_("net idmap secret <DOMAIN> <secret>\n"
716 " Set secret for specified domain")
719 "aclmapset",
720 net_idmap_aclmapset,
721 NET_TRANSPORT_LOCAL,
722 N_("Set acl map"),
723 N_("net idmap aclmapset\n"
724 " Set acl map")
727 "check",
728 net_idmap_check,
729 NET_TRANSPORT_LOCAL,
730 N_("Check id mappings"),
731 N_("net idmap check\n"
732 " Check id mappings")
734 {NULL, NULL, 0, NULL, NULL}
737 return net_run_function(c, argc, argv, "net idmap", func);