2 Samba Unix/Linux CIFS implementation
4 low level TDB/CTDB tool using the dbwrap interface
6 Copyright (C) 2009 Michael Adam <obnox@samba.org>
7 Copyright (C) 2011 Bjoern Baumbach <bb@sernet.de>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "system/filesys.h"
25 #include "popt_common.h"
26 #include "dbwrap/dbwrap.h"
27 #include "dbwrap/dbwrap_open.h"
30 #include "cmdline_contexts.h"
32 enum dbwrap_op { OP_FETCH, OP_STORE, OP_DELETE, OP_ERASE, OP_LISTKEYS,
35 enum dbwrap_type { TYPE_INT32, TYPE_UINT32, TYPE_STRING, TYPE_HEX, TYPE_NONE };
37 static int dbwrap_tool_fetch_int32(struct db_context *db,
44 status = dbwrap_fetch_int32_bystring(db, keyname, &value);
45 if (!NT_STATUS_IS_OK(status)) {
46 d_printf("Error fetching int32 from key '%s': %s\n",
47 keyname, nt_errstr(status));
50 d_printf("%d\n", value);
55 static int dbwrap_tool_fetch_uint32(struct db_context *db,
62 ret = dbwrap_fetch_uint32_bystring(db, keyname, &value);
63 if (NT_STATUS_IS_OK(ret)) {
64 d_printf("%u\n", value);
67 d_fprintf(stderr, "ERROR: could not fetch uint32 key '%s': "
68 "%s\n", nt_errstr(ret), keyname);
73 static int dbwrap_tool_fetch_string(struct db_context *db,
79 TALLOC_CTX *tmp_ctx = talloc_stackframe();
82 status = dbwrap_fetch_bystring(db, tmp_ctx, keyname, &tdbdata);
83 if (NT_STATUS_IS_OK(status)) {
84 d_printf("%-*.*s\n", (int)tdbdata.dsize, (int)tdbdata.dsize,
88 d_fprintf(stderr, "ERROR: could not fetch string key '%s': "
89 "%s\n", nt_errstr(status), keyname);
97 static int dbwrap_tool_fetch_hex(struct db_context *db,
104 TALLOC_CTX *tmp_ctx = talloc_stackframe();
108 status = dbwrap_fetch_bystring(db, tmp_ctx, keyname, &tdbdata);
109 if (NT_STATUS_IS_OK(status)) {
110 datablob.data = tdbdata.dptr;
111 datablob.length = tdbdata.dsize;
113 hex_string = data_blob_hex_string_upper(tmp_ctx, &datablob);
114 if (hex_string == NULL) {
115 d_fprintf(stderr, "ERROR: could not get hex string "
119 d_printf("%s\n", hex_string);
123 d_fprintf(stderr, "ERROR: could not fetch hex key '%s': "
124 "%s\n", nt_errstr(status), keyname);
128 talloc_free(tmp_ctx);
132 static int dbwrap_tool_store_int32(struct db_context *db,
137 int32_t value = (int32_t)strtol(data, NULL, 10);
139 if (dbwrap_is_persistent(db)) {
140 status = dbwrap_trans_store_int32_bystring(db, keyname, value);
142 status = dbwrap_store_int32_bystring(db, keyname, value);
144 if (!NT_STATUS_IS_OK(status)) {
145 d_fprintf(stderr, "ERROR: could not store int32 key '%s': %s\n",
146 keyname, nt_errstr(status));
153 static int dbwrap_tool_store_uint32(struct db_context *db,
158 uint32_t value = (uint32_t)strtol(data, NULL, 10);
160 if (dbwrap_is_persistent(db)) {
161 status = dbwrap_trans_store_uint32_bystring(db, keyname, value);
163 status = dbwrap_store_uint32_bystring(db, keyname, value);
165 if (!NT_STATUS_IS_OK(status)) {
167 "ERROR: could not store uint32 key '%s': %s\n",
168 keyname, nt_errstr(status));
175 static int dbwrap_tool_store_string(struct db_context *db,
182 tdbdata = string_term_tdb_data(data);
184 if (dbwrap_is_persistent(db)) {
185 status = dbwrap_trans_store_bystring(db, keyname,
189 status = dbwrap_store_bystring(db, keyname,
193 if (!NT_STATUS_IS_OK(status)) {
195 "ERROR: could not store string key '%s': %s\n",
196 keyname, nt_errstr(status));
203 static int dbwrap_tool_store_hex(struct db_context *db,
210 TALLOC_CTX *tmp_ctx = talloc_stackframe();
212 datablob = strhex_to_data_blob(tmp_ctx, data);
213 if(strlen(data) > 0 && datablob.length == 0) {
215 "ERROR: could not convert hex string to data blob\n"
216 " Not a valid hex string?\n");
217 talloc_free(tmp_ctx);
221 tdbdata.dptr = (unsigned char *)datablob.data;
222 tdbdata.dsize = datablob.length;
224 if (dbwrap_is_persistent(db)) {
225 status = dbwrap_trans_store_bystring(db, keyname,
229 status = dbwrap_store_bystring(db, keyname,
233 if (!NT_STATUS_IS_OK(status)) {
235 "ERROR: could not store string key '%s': %s\n",
236 keyname, nt_errstr(status));
237 talloc_free(tmp_ctx);
241 talloc_free(tmp_ctx);
245 static int dbwrap_tool_delete(struct db_context *db,
251 if (dbwrap_is_persistent(db)) {
252 status = dbwrap_trans_delete_bystring(db, keyname);
254 status = dbwrap_delete_bystring(db, keyname);
257 if (!NT_STATUS_IS_OK(status)) {
258 d_fprintf(stderr, "ERROR deleting record %s : %s\n",
259 keyname, nt_errstr(status));
266 static int dbwrap_tool_exists(struct db_context *db,
272 result = dbwrap_exists(db, string_term_tdb_data(keyname));
275 d_fprintf(stdout, "Key %s exists\n", keyname);
277 d_fprintf(stdout, "Key %s does not exist\n", keyname);
284 * dbwrap_tool_erase: erase the whole data base
285 * the keyname argument is not used.
287 static int dbwrap_tool_erase(struct db_context *db,
293 ret = dbwrap_wipe(db);
296 d_fprintf(stderr, "ERROR erasing the database\n");
303 static int listkey_fn(struct db_record *rec, void *private_data)
305 TDB_DATA key = dbwrap_record_get_key(rec);
306 size_t length = key.dsize;
307 unsigned char *p = (unsigned char *)key.dptr;
310 if (isprint(*p) && !strchr("\"\\", *p)) {
313 d_printf("\\%02X", *p);
323 static int dbwrap_tool_listkeys(struct db_context *db,
329 status = dbwrap_traverse_read(db, listkey_fn, NULL, NULL);
331 if (!NT_STATUS_IS_OK(status)) {
332 d_fprintf(stderr, "ERROR listing db keys\n");
339 struct dbwrap_op_dispatch_table {
341 enum dbwrap_type type;
342 int (*cmd)(struct db_context *db,
347 struct dbwrap_op_dispatch_table dispatch_table[] = {
348 { OP_FETCH, TYPE_INT32, dbwrap_tool_fetch_int32 },
349 { OP_FETCH, TYPE_UINT32, dbwrap_tool_fetch_uint32 },
350 { OP_FETCH, TYPE_STRING, dbwrap_tool_fetch_string },
351 { OP_FETCH, TYPE_HEX, dbwrap_tool_fetch_hex },
352 { OP_STORE, TYPE_INT32, dbwrap_tool_store_int32 },
353 { OP_STORE, TYPE_UINT32, dbwrap_tool_store_uint32 },
354 { OP_STORE, TYPE_STRING, dbwrap_tool_store_string },
355 { OP_STORE, TYPE_HEX, dbwrap_tool_store_hex },
356 { OP_DELETE, TYPE_INT32, dbwrap_tool_delete },
357 { OP_ERASE, TYPE_INT32, dbwrap_tool_erase },
358 { OP_LISTKEYS, TYPE_INT32, dbwrap_tool_listkeys },
359 { OP_EXISTS, TYPE_STRING, dbwrap_tool_exists },
363 int main(int argc, const char **argv)
365 struct tevent_context *evt_ctx;
366 struct messaging_context *msg_ctx;
367 struct db_context *db;
374 const char *keyname = "";
375 const char *keytype = "int32";
376 enum dbwrap_type type;
377 const char *valuestr = "0";
379 int non_persistent = 0;
380 int tdb_flags = TDB_DEFAULT;
382 TALLOC_CTX *mem_ctx = talloc_stackframe();
386 struct poptOption popt_options[] = {
389 { "non-persistent", 0, POPT_ARG_NONE, &non_persistent, 0,
390 "treat the database as non-persistent "
391 "(CAVEAT: This mode might wipe your database!)",
393 { "persistent", 0, POPT_ARG_NONE, &persistent, 0,
394 "treat the database as persistent",
399 const char **extra_argv;
404 lp_set_cmdline("log level", "0");
405 setup_logging(argv[0], DEBUG_STDERR);
407 pc = poptGetContext(argv[0], argc, argv, popt_options, POPT_CONTEXT_KEEP_FIRST);
409 while ((opt = poptGetNextOpt(pc)) != -1) {
412 fprintf(stderr, "Invalid option %s: %s\n",
413 poptBadOption(pc, 0), poptStrerror(opt));
418 /* setup the remaining options for the main program to use */
419 extra_argv = poptGetArgs(pc);
422 while (extra_argv[extra_argc]) extra_argc++;
425 cmdline_messaging_context(get_dyn_CONFIGFILE());
427 lp_load_global(get_dyn_CONFIGFILE());
429 if ((extra_argc < 2) || (extra_argc > 5)) {
431 "USAGE: %s [options] <database> <op> [<key> [<type> "
433 " ops: fetch, store, delete, exists, "
435 " types: int32, uint32, string, hex\n",
440 if ((persistent + non_persistent) != 1) {
441 d_fprintf(stderr, "ERROR: you must specify exactly one "
442 "of --persistent and --non-persistent\n");
445 if (non_persistent == 1) {
446 tdb_flags |= TDB_CLEAR_IF_FIRST;
449 dbname = extra_argv[0];
450 opname = extra_argv[1];
452 if (strcmp(opname, "store") == 0) {
453 if (extra_argc != 5) {
454 d_fprintf(stderr, "ERROR: operation 'store' requires "
458 valuestr = extra_argv[4];
459 keytype = extra_argv[3];
460 keyname = extra_argv[2];
462 } else if (strcmp(opname, "fetch") == 0) {
463 if (extra_argc != 4) {
464 d_fprintf(stderr, "ERROR: operation 'fetch' requires "
465 "type but not value argument\n");
469 keytype = extra_argv[3];
470 keyname = extra_argv[2];
471 } else if (strcmp(opname, "delete") == 0) {
472 if (extra_argc != 3) {
473 d_fprintf(stderr, "ERROR: operation 'delete' does "
474 "not allow type nor value argument\n");
477 keyname = extra_argv[2];
479 } else if (strcmp(opname, "erase") == 0) {
480 if (extra_argc != 2) {
481 d_fprintf(stderr, "ERROR: operation 'erase' does "
482 "not take a key argument\n");
486 } else if (strcmp(opname, "listkeys") == 0) {
487 if (extra_argc != 2) {
488 d_fprintf(stderr, "ERROR: operation 'listkeys' does "
489 "not take a key argument\n");
493 } else if (strcmp(opname, "exists") == 0) {
494 if (extra_argc != 3) {
495 d_fprintf(stderr, "ERROR: operation 'exists' does "
496 "not allow type nor value argument\n");
499 keyname = extra_argv[2];
504 "ERROR: invalid op '%s' specified\n"
505 " supported ops: fetch, store, delete, exists, "
511 if (strcmp(keytype, "int32") == 0) {
513 } else if (strcmp(keytype, "uint32") == 0) {
515 } else if (strcmp(keytype, "string") == 0) {
517 } else if (strcmp(keytype, "hex") == 0) {
519 } else if (strcmp(keytype, "none") == 0) {
522 d_fprintf(stderr, "ERROR: invalid type '%s' specified.\n"
523 " supported types: int32, uint32, "
524 "string, hex, none\n",
529 evt_ctx = samba_tevent_context_init(mem_ctx);
530 if (evt_ctx == NULL) {
531 d_fprintf(stderr, "ERROR: could not init event context\n");
535 msg_ctx = messaging_init(mem_ctx, evt_ctx);
536 if (msg_ctx == NULL) {
537 d_fprintf(stderr, "ERROR: could not init messaging context\n");
548 db = db_open(mem_ctx, dbname, 0, tdb_flags, O_RDWR | O_CREAT,
549 0644, DBWRAP_LOCK_ORDER_1, DBWRAP_FLAG_NONE);
551 d_fprintf(stderr, "ERROR: could not open dbname\n");
560 for (count = 0; dispatch_table[count].cmd != NULL; count++) {
561 if ((op == dispatch_table[count].op) &&
562 (type == dispatch_table[count].type))
564 ret = dispatch_table[count].cmd(db, keyname, valuestr);
570 TALLOC_FREE(mem_ctx);