1 /*
2 Samba Unix/Linux CIFS implementation
3
4 low level TDB/CTDB tool using the dbwrap interface
5
6 Copyright (C) 2009 Michael Adam <obnox@samba.org>
7 Copyright (C) 2011 Bjoern Baumbach <bb@sernet.de>
8
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.
13
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.
18
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/>.
21 */
22
23 #include "includes.h"
24 #include "system/filesys.h"
25 #include "popt_common.h"
26 #include "dbwrap/dbwrap.h"
27 #include "dbwrap/dbwrap_open.h"
28 #include "messages.h"
29 #include "util_tdb.h"
30 #include "cmdline_contexts.h"
31
32 enum dbwrap_op { OP_FETCH, OP_STORE, OP_DELETE, OP_ERASE, OP_LISTKEYS,
33 OP_EXISTS };
34
35 enum dbwrap_type { TYPE_INT32, TYPE_UINT32, TYPE_STRING, TYPE_HEX, TYPE_NONE };
36
dbwrap_tool_fetch_int32(struct db_context * db,const char * keyname,const char * data)37 static int dbwrap_tool_fetch_int32(struct db_context *db,
38 const char *keyname,
39 const char *data)
40 {
41 int32_t value;
42 NTSTATUS status;
43
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));
48 return -1;
49 }
50 d_printf("%d\n", value);
51
52 return 0;
53 }
54
dbwrap_tool_fetch_uint32(struct db_context * db,const char * keyname,const char * data)55 static int dbwrap_tool_fetch_uint32(struct db_context *db,
56 const char *keyname,
57 const char *data)
58 {
59 uint32_t value;
60 NTSTATUS ret;
61
62 ret = dbwrap_fetch_uint32_bystring(db, keyname, &value);
63 if (NT_STATUS_IS_OK(ret)) {
64 d_printf("%u\n", value);
65 return 0;
66 } else {
67 d_fprintf(stderr, "ERROR: could not fetch uint32 key '%s': "
68 "%s\n", nt_errstr(ret), keyname);
69 return -1;
70 }
71 }
72
dbwrap_tool_fetch_string(struct db_context * db,const char * keyname,const char * data)73 static int dbwrap_tool_fetch_string(struct db_context *db,
74 const char *keyname,
75 const char *data)
76 {
77 TDB_DATA tdbdata;
78 NTSTATUS status;
79 TALLOC_CTX *tmp_ctx = talloc_stackframe();
80 int ret;
81
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,
85 tdbdata.dptr);
86 ret = 0;
87 } else {
88 d_fprintf(stderr, "ERROR: could not fetch string key '%s': "
89 "%s\n", nt_errstr(status), keyname);
90 ret = -1;
91 }
92
93 talloc_free(tmp_ctx);
94 return ret;
95 }
96
dbwrap_tool_fetch_hex(struct db_context * db,const char * keyname,const char * data)97 static int dbwrap_tool_fetch_hex(struct db_context *db,
98 const char *keyname,
99 const char *data)
100 {
101 TDB_DATA tdbdata;
102 DATA_BLOB datablob;
103 NTSTATUS status;
104 TALLOC_CTX *tmp_ctx = talloc_stackframe();
105 char *hex_string;
106 int ret;
107
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;
112
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 "
116 "from data blob\n");
117 ret = -1;
118 } else {
119 d_printf("%s\n", hex_string);
120 ret = 0;
121 }
122 } else {
123 d_fprintf(stderr, "ERROR: could not fetch hex key '%s': "
124 "%s\n", nt_errstr(status), keyname);
125 ret = -1;
126 }
127
128 talloc_free(tmp_ctx);
129 return ret;
130 }
131
dbwrap_tool_store_int32(struct db_context * db,const char * keyname,const char * data)132 static int dbwrap_tool_store_int32(struct db_context *db,
133 const char *keyname,
134 const char *data)
135 {
136 NTSTATUS status;
137 int32_t value = (int32_t)strtol(data, NULL, 10);
138
139 if (dbwrap_is_persistent(db)) {
140 status = dbwrap_trans_store_int32_bystring(db, keyname, value);
141 } else {
142 status = dbwrap_store_int32_bystring(db, keyname, value);
143 }
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));
147 return -1;
148 }
149
150 return 0;
151 }
152
dbwrap_tool_store_uint32(struct db_context * db,const char * keyname,const char * data)153 static int dbwrap_tool_store_uint32(struct db_context *db,
154 const char *keyname,
155 const char *data)
156 {
157 NTSTATUS status;
158 uint32_t value = (uint32_t)strtol(data, NULL, 10);
159
160 if (dbwrap_is_persistent(db)) {
161 status = dbwrap_trans_store_uint32_bystring(db, keyname, value);
162 } else {
163 status = dbwrap_store_uint32_bystring(db, keyname, value);
164 }
165 if (!NT_STATUS_IS_OK(status)) {
166 d_fprintf(stderr,
167 "ERROR: could not store uint32 key '%s': %s\n",
168 keyname, nt_errstr(status));
169 return -1;
170 }
171
172 return 0;
173 }
174
dbwrap_tool_store_string(struct db_context * db,const char * keyname,const char * data)175 static int dbwrap_tool_store_string(struct db_context *db,
176 const char *keyname,
177 const char *data)
178 {
179 NTSTATUS status;
180 TDB_DATA tdbdata;
181
182 tdbdata = string_term_tdb_data(data);
183
184 if (dbwrap_is_persistent(db)) {
185 status = dbwrap_trans_store_bystring(db, keyname,
186 tdbdata,
187 TDB_REPLACE);
188 } else {
189 status = dbwrap_store_bystring(db, keyname,
190 tdbdata,
191 TDB_REPLACE);
192 }
193 if (!NT_STATUS_IS_OK(status)) {
194 d_fprintf(stderr,
195 "ERROR: could not store string key '%s': %s\n",
196 keyname, nt_errstr(status));
197 return -1;
198 }
199
200 return 0;
201 }
202
dbwrap_tool_store_hex(struct db_context * db,const char * keyname,const char * data)203 static int dbwrap_tool_store_hex(struct db_context *db,
204 const char *keyname,
205 const char *data)
206 {
207 NTSTATUS status;
208 DATA_BLOB datablob;
209 TDB_DATA tdbdata;
210 TALLOC_CTX *tmp_ctx = talloc_stackframe();
211
212 datablob = strhex_to_data_blob(tmp_ctx, data);
213 if(strlen(data) > 0 && datablob.length == 0) {
214 d_fprintf(stderr,
215 "ERROR: could not convert hex string to data blob\n"
216 " Not a valid hex string?\n");
217 talloc_free(tmp_ctx);
218 return -1;
219 }
220
221 tdbdata.dptr = (unsigned char *)datablob.data;
222 tdbdata.dsize = datablob.length;
223
224 if (dbwrap_is_persistent(db)) {
225 status = dbwrap_trans_store_bystring(db, keyname,
226 tdbdata,
227 TDB_REPLACE);
228 } else {
229 status = dbwrap_store_bystring(db, keyname,
230 tdbdata,
231 TDB_REPLACE);
232 }
233 if (!NT_STATUS_IS_OK(status)) {
234 d_fprintf(stderr,
235 "ERROR: could not store string key '%s': %s\n",
236 keyname, nt_errstr(status));
237 talloc_free(tmp_ctx);
238 return -1;
239 }
240
241 talloc_free(tmp_ctx);
242 return 0;
243 }
244
dbwrap_tool_delete(struct db_context * db,const char * keyname,const char * data)245 static int dbwrap_tool_delete(struct db_context *db,
246 const char *keyname,
247 const char *data)
248 {
249 NTSTATUS status;
250
251 if (dbwrap_is_persistent(db)) {
252 status = dbwrap_trans_delete_bystring(db, keyname);
253 } else {
254 status = dbwrap_delete_bystring(db, keyname);
255 }
256
257 if (!NT_STATUS_IS_OK(status)) {
258 d_fprintf(stderr, "ERROR deleting record %s : %s\n",
259 keyname, nt_errstr(status));
260 return -1;
261 }
262
263 return 0;
264 }
265
dbwrap_tool_exists(struct db_context * db,const char * keyname,const char * data)266 static int dbwrap_tool_exists(struct db_context *db,
267 const char *keyname,
268 const char *data)
269 {
270 bool result;
271
272 result = dbwrap_exists(db, string_term_tdb_data(keyname));
273
274 if (result) {
275 d_fprintf(stdout, "Key %s exists\n", keyname);
276 } else {
277 d_fprintf(stdout, "Key %s does not exist\n", keyname);
278 }
279
280 return (result)?0:1;
281 }
282
283 /**
284 * dbwrap_tool_erase: erase the whole data base
285 * the keyname argument is not used.
286 */
dbwrap_tool_erase(struct db_context * db,const char * keyname,const char * data)287 static int dbwrap_tool_erase(struct db_context *db,
288 const char *keyname,
289 const char *data)
290 {
291 int ret;
292
293 ret = dbwrap_wipe(db);
294
295 if (ret != 0) {
296 d_fprintf(stderr, "ERROR erasing the database\n");
297 return -1;
298 }
299
300 return 0;
301 }
302
listkey_fn(struct db_record * rec,void * private_data)303 static int listkey_fn(struct db_record *rec, void *private_data)
304 {
305 TDB_DATA key = dbwrap_record_get_key(rec);
306 size_t length = key.dsize;
307 unsigned char *p = (unsigned char *)key.dptr;
308
309 while (length--) {
310 if (isprint(*p) && !strchr("\"\\", *p)) {
311 d_printf("%c", *p);
312 } else {
313 d_printf("\\%02X", *p);
314 }
315 p++;
316 }
317
318 d_printf("\n");
319
320 return 0;
321 }
322
dbwrap_tool_listkeys(struct db_context * db,const char * keyname,const char * data)323 static int dbwrap_tool_listkeys(struct db_context *db,
324 const char *keyname,
325 const char *data)
326 {
327 NTSTATUS status;
328
329 status = dbwrap_traverse_read(db, listkey_fn, NULL, NULL);
330
331 if (!NT_STATUS_IS_OK(status)) {
332 d_fprintf(stderr, "ERROR listing db keys\n");
333 return -1;
334 }
335
336 return 0;
337 }
338
339 struct dbwrap_op_dispatch_table {
340 enum dbwrap_op op;
341 enum dbwrap_type type;
342 int (*cmd)(struct db_context *db,
343 const char *keyname,
344 const char *data);
345 };
346
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 },
360 { 0, 0, NULL },
361 };
362
main(int argc,const char ** argv)363 int main(int argc, const char **argv)
364 {
365 struct tevent_context *evt_ctx;
366 struct messaging_context *msg_ctx;
367 struct db_context *db;
368
369 uint16_t count;
370
371 const char *dbname;
372 const char *opname;
373 enum dbwrap_op op;
374 const char *keyname = "";
375 const char *keytype = "int32";
376 enum dbwrap_type type;
377 const char *valuestr = "0";
378 int persistent = 0;
379 int non_persistent = 0;
380 int tdb_flags = TDB_DEFAULT;
381
382 TALLOC_CTX *mem_ctx = talloc_stackframe();
383
384 int ret = 1;
385
386 struct poptOption popt_options[] = {
387 POPT_AUTOHELP
388 POPT_COMMON_SAMBA
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!)",
392 NULL },
393 { "persistent", 0, POPT_ARG_NONE, &persistent, 0,
394 "treat the database as persistent",
395 NULL },
396 POPT_TABLEEND
397 };
398 int opt;
399 const char **extra_argv;
400 int extra_argc = 0;
401 poptContext pc;
402
403 smb_init_locale();
404 lp_set_cmdline("log level", "0");
405 setup_logging(argv[0], DEBUG_STDERR);
406
407 pc = poptGetContext(argv[0], argc, argv, popt_options, POPT_CONTEXT_KEEP_FIRST);
408
409 while ((opt = poptGetNextOpt(pc)) != -1) {
410 switch (opt) {
411 default:
412 fprintf(stderr, "Invalid option %s: %s\n",
413 poptBadOption(pc, 0), poptStrerror(opt));
414 goto done;
415 }
416 }
417
418 /* setup the remaining options for the main program to use */
419 extra_argv = poptGetArgs(pc);
420 if (extra_argv) {
421 extra_argv++;
422 while (extra_argv[extra_argc]) extra_argc++;
423 }
424
425 lp_load_global(get_dyn_CONFIGFILE());
426
427 if ((extra_argc < 2) || (extra_argc > 5)) {
428 d_fprintf(stderr,
429 "USAGE: %s [options] <database> <op> [<key> [<type> "
430 "[<value>]]]\n"
431 " ops: fetch, store, delete, exists, "
432 "erase, listkeys\n"
433 " types: int32, uint32, string, hex\n",
434 argv[0]);
435 goto done;
436 }
437
438 if ((persistent + non_persistent) != 1) {
439 d_fprintf(stderr, "ERROR: you must specify exactly one "
440 "of --persistent and --non-persistent\n");
441 goto done;
442 }
443 if (non_persistent == 1) {
444 tdb_flags |= TDB_CLEAR_IF_FIRST;
445 }
446
447 dbname = extra_argv[0];
448 opname = extra_argv[1];
449
450 if (strcmp(opname, "store") == 0) {
451 if (extra_argc != 5) {
452 d_fprintf(stderr, "ERROR: operation 'store' requires "
453 "value argument\n");
454 goto done;
455 }
456 valuestr = extra_argv[4];
457 keytype = extra_argv[3];
458 keyname = extra_argv[2];
459 op = OP_STORE;
460 } else if (strcmp(opname, "fetch") == 0) {
461 if (extra_argc != 4) {
462 d_fprintf(stderr, "ERROR: operation 'fetch' requires "
463 "type but not value argument\n");
464 goto done;
465 }
466 op = OP_FETCH;
467 keytype = extra_argv[3];
468 keyname = extra_argv[2];
469 } else if (strcmp(opname, "delete") == 0) {
470 if (extra_argc != 3) {
471 d_fprintf(stderr, "ERROR: operation 'delete' does "
472 "not allow type nor value argument\n");
473 goto done;
474 }
475 keyname = extra_argv[2];
476 op = OP_DELETE;
477 } else if (strcmp(opname, "erase") == 0) {
478 if (extra_argc != 2) {
479 d_fprintf(stderr, "ERROR: operation 'erase' does "
480 "not take a key argument\n");
481 goto done;
482 }
483 op = OP_ERASE;
484 } else if (strcmp(opname, "listkeys") == 0) {
485 if (extra_argc != 2) {
486 d_fprintf(stderr, "ERROR: operation 'listkeys' does "
487 "not take a key argument\n");
488 goto done;
489 }
490 op = OP_LISTKEYS;
491 } else if (strcmp(opname, "exists") == 0) {
492 if (extra_argc != 3) {
493 d_fprintf(stderr, "ERROR: operation 'exists' does "
494 "not allow type nor value argument\n");
495 goto done;
496 }
497 keyname = extra_argv[2];
498 op = OP_EXISTS;
499 keytype = "string";
500 } else {
501 d_fprintf(stderr,
502 "ERROR: invalid op '%s' specified\n"
503 " supported ops: fetch, store, delete, exists, "
504 "erase, listkeys\n",
505 opname);
506 goto done;
507 }
508
509 if (strcmp(keytype, "int32") == 0) {
510 type = TYPE_INT32;
511 } else if (strcmp(keytype, "uint32") == 0) {
512 type = TYPE_UINT32;
513 } else if (strcmp(keytype, "string") == 0) {
514 type = TYPE_STRING;
515 } else if (strcmp(keytype, "hex") == 0) {
516 type = TYPE_HEX;
517 } else if (strcmp(keytype, "none") == 0) {
518 type = TYPE_NONE;
519 } else {
520 d_fprintf(stderr, "ERROR: invalid type '%s' specified.\n"
521 " supported types: int32, uint32, "
522 "string, hex, none\n",
523 keytype);
524 goto done;
525 }
526
527 evt_ctx = samba_tevent_context_init(mem_ctx);
528 if (evt_ctx == NULL) {
529 d_fprintf(stderr, "ERROR: could not init event context\n");
530 goto done;
531 }
532
533 msg_ctx = messaging_init(mem_ctx, evt_ctx);
534 if (msg_ctx == NULL) {
535 d_fprintf(stderr, "ERROR: could not init messaging context\n");
536 goto done;
537 }
538
539 switch (op) {
540 case OP_FETCH:
541 case OP_STORE:
542 case OP_DELETE:
543 case OP_ERASE:
544 case OP_LISTKEYS:
545 case OP_EXISTS:
546 db = db_open(mem_ctx, dbname, 0, tdb_flags, O_RDWR | O_CREAT,
547 0644, DBWRAP_LOCK_ORDER_1, DBWRAP_FLAG_NONE);
548 if (db == NULL) {
549 d_fprintf(stderr, "ERROR: could not open dbname\n");
550 goto done;
551 }
552 break;
553 default:
554 db = NULL;
555 break;
556 }
557
558 for (count = 0; dispatch_table[count].cmd != NULL; count++) {
559 if ((op == dispatch_table[count].op) &&
560 (type == dispatch_table[count].type))
561 {
562 ret = dispatch_table[count].cmd(db, keyname, valuestr);
563 break;
564 }
565 }
566
567 done:
568 poptFreeContext(pc);
569 TALLOC_FREE(mem_ctx);
570 return ret;
571 }
572