2 Unix SMB/CIFS implementation.
3 simple registry frontend
5 Copyright (C) Jelmer Vernooij 2004-2007
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "lib/registry/registry.h"
23 #include "lib/cmdline/popt_common.h"
24 #include "lib/events/events.h"
25 #include "system/time.h"
26 #include "lib/smbreadline/smbreadline.h"
27 #include "librpc/gen_ndr/ndr_security.h"
28 #include "lib/registry/tools/common.h"
29 #include "param/param.h"
31 struct regshell_context {
32 struct registry_context *registry;
34 struct registry_key *current;
39 * ls - list values/keys
40 * rmval/rm - remove value
41 * rmkey/rmdir - remove key
42 * mkkey/mkdir - make key
44 * info - show key info
51 static WERROR cmd_info(struct regshell_context *ctx, int argc, char **argv)
53 struct security_descriptor *sec_desc = NULL;
56 const char *classname = NULL;
58 uint32_t max_subkeynamelen;
59 uint32_t max_valnamelen;
60 uint32_t max_valbufsize;
64 error = reg_key_get_info(ctx, ctx->current, &classname, &num_subkeys, &num_values,
65 &last_change, &max_subkeynamelen, &max_valnamelen, &max_valbufsize);
66 if (!W_ERROR_IS_OK(error)) {
67 printf("Error getting key info: %s\n", win_errstr(error));
72 printf("Name: %s\n", strchr(ctx->path, '\\')?strrchr(ctx->path, '\\')+1:
74 printf("Full path: %s\n", ctx->path);
75 if (classname != NULL)
76 printf("Key Class: %s\n", classname);
77 last_mod = nt_time_to_unix(last_change);
78 printf("Time Last Modified: %s\n", ctime(&last_mod));
79 printf("Number of subkeys: %d\n", num_subkeys);
80 printf("Number of values: %d\n", num_values);
82 if (max_valnamelen > 0)
83 printf("Maximum value name length: %d\n", max_valnamelen);
85 if (max_valbufsize > 0)
86 printf("Maximum value data length: %d\n", max_valbufsize);
88 if (max_subkeynamelen > 0)
89 printf("Maximum sub key name length: %d\n", max_subkeynamelen);
91 error = reg_get_sec_desc(ctx, ctx->current, &sec_desc);
92 if (!W_ERROR_IS_OK(error)) {
93 printf("Error getting security descriptor\n");
96 ndr_print_debug((ndr_print_fn_t)ndr_print_security_descriptor,
97 "Security", sec_desc);
98 talloc_free(sec_desc);
103 static WERROR cmd_predef(struct regshell_context *ctx, int argc, char **argv)
105 struct registry_key *ret = NULL;
107 fprintf(stderr, "Usage: predef predefined-key-name\n");
109 fprintf(stderr, "No full registry loaded, no predefined keys defined\n");
111 WERROR error = reg_get_predefined_key_by_name(ctx->registry,
114 if (!W_ERROR_IS_OK(error)) {
115 fprintf(stderr, "Error opening predefined key %s: %s\n",
116 argv[1], win_errstr(error));
120 ctx->path = strupper_talloc(ctx, argv[1]);
127 static WERROR cmd_pwd(struct regshell_context *ctx,
128 int argc, char **argv)
130 printf("%s\n", ctx->path);
134 static WERROR cmd_set(struct regshell_context *ctx, int argc, char **argv)
136 struct registry_value val;
140 fprintf(stderr, "Usage: set value-name type value\n");
141 return WERR_INVALID_PARAM;
144 if (!reg_string_to_val(ctx, lp_iconv_convenience(cmdline_lp_ctx),
145 argv[2], argv[3], &val.data_type,
147 fprintf(stderr, "Unable to interpret data\n");
148 return WERR_INVALID_PARAM;
151 error = reg_val_set(ctx->current, argv[1], val.data_type, val.data);
152 if (!W_ERROR_IS_OK(error)) {
153 fprintf(stderr, "Error setting value: %s\n", win_errstr(error));
160 static WERROR cmd_ck(struct regshell_context *ctx, int argc, char **argv)
162 struct registry_key *new = NULL;
168 error = reg_open_key(ctx->registry, ctx->current, argv[1],
170 if(!W_ERROR_IS_OK(error)) {
171 DEBUG(0, ("Error opening specified key: %s\n",
177 ctx->path = talloc_asprintf(ctx, "%s\\%s", ctx->path, argv[1]);
178 printf("Current path is: %s\n", ctx->path);
184 static WERROR cmd_print(struct regshell_context *ctx, int argc, char **argv)
187 DATA_BLOB value_data;
191 fprintf(stderr, "Usage: print <valuename>");
192 return WERR_INVALID_PARAM;
195 error = reg_key_get_value_by_name(ctx, ctx->current, argv[1],
196 &value_type, &value_data);
197 if (!W_ERROR_IS_OK(error)) {
198 fprintf(stderr, "No such value '%s'\n", argv[1]);
202 printf("%s\n%s\n", str_regtype(value_type),
203 reg_val_data_string(ctx, lp_iconv_convenience(cmdline_lp_ctx), value_type, value_data));
208 static WERROR cmd_ls(struct regshell_context *ctx, int argc, char **argv)
214 const char *name = NULL;
216 for (i = 0; W_ERROR_IS_OK(error = reg_key_get_subkey_by_index(ctx,
222 printf("K %s\n", name);
225 if (!W_ERROR_EQUAL(error, WERR_NO_MORE_ITEMS)) {
226 DEBUG(0, ("Error occured while browsing thru keys: %s\n",
230 for (i = 0; W_ERROR_IS_OK(error = reg_key_get_value_by_index(ctx,
236 printf("V \"%s\" %s %s\n", name, str_regtype(data_type),
237 reg_val_data_string(ctx, lp_iconv_convenience(cmdline_lp_ctx), data_type, data));
242 static WERROR cmd_mkkey(struct regshell_context *ctx, int argc, char **argv)
244 struct registry_key *tmp;
248 fprintf(stderr, "Usage: mkkey <keyname>\n");
249 return WERR_INVALID_PARAM;
252 error = reg_key_add_name(ctx, ctx->current, argv[1], 0, NULL, &tmp);
254 if (!W_ERROR_IS_OK(error)) {
255 fprintf(stderr, "Error adding new subkey '%s'\n", argv[1]);
262 static WERROR cmd_rmkey(struct regshell_context *ctx,
263 int argc, char **argv)
268 fprintf(stderr, "Usage: rmkey <name>\n");
269 return WERR_INVALID_PARAM;
272 error = reg_key_del(ctx->current, argv[1]);
273 if(!W_ERROR_IS_OK(error)) {
274 fprintf(stderr, "Error deleting '%s'\n", argv[1]);
277 fprintf(stderr, "Successfully deleted '%s'\n", argv[1]);
283 static WERROR cmd_rmval(struct regshell_context *ctx, int argc, char **argv)
288 fprintf(stderr, "Usage: rmval <valuename>\n");
289 return WERR_INVALID_PARAM;
292 error = reg_del_value(ctx->current, argv[1]);
293 if(!W_ERROR_IS_OK(error)) {
294 fprintf(stderr, "Error deleting value '%s'\n", argv[1]);
297 fprintf(stderr, "Successfully deleted value '%s'\n", argv[1]);
303 _NORETURN_ static WERROR cmd_exit(struct regshell_context *ctx,
304 int argc, char **argv)
310 static WERROR cmd_help(struct regshell_context *ctx, int, char **);
316 WERROR (*handle)(struct regshell_context *ctx, int argc, char **argv);
317 } regshell_cmds[] = {
318 {"ck", "cd", "Change current key", cmd_ck },
319 {"info", "i", "Show detailed information of a key", cmd_info },
320 {"list", "ls", "List values/keys in current key", cmd_ls },
321 {"print", "p", "Print value", cmd_print },
322 {"mkkey", "mkdir", "Make new key", cmd_mkkey },
323 {"rmval", "rm", "Remove value", cmd_rmval },
324 {"rmkey", "rmdir", "Remove key", cmd_rmkey },
325 {"pwd", "pwk", "Printing current key", cmd_pwd },
326 {"set", "update", "Update value", cmd_set },
327 {"help", "?", "Help", cmd_help },
328 {"exit", "quit", "Exit", cmd_exit },
329 {"predef", "predefined", "Go to predefined key", cmd_predef },
333 static WERROR cmd_help(struct regshell_context *ctx,
334 int argc, char **argv)
337 printf("Available commands:\n");
338 for(i = 0; regshell_cmds[i].name; i++) {
339 printf("%s - %s\n", regshell_cmds[i].name,
340 regshell_cmds[i].help);
345 static WERROR process_cmd(struct regshell_context *ctx,
352 if ((ret = poptParseArgvString(line, &argc, (const char ***) &argv)) != 0) {
353 fprintf(stderr, "regshell: %s\n", poptStrerror(ret));
354 return WERR_INVALID_PARAM;
357 for(i = 0; regshell_cmds[i].name; i++) {
358 if(!strcmp(regshell_cmds[i].name, argv[0]) ||
359 (regshell_cmds[i].alias && !strcmp(regshell_cmds[i].alias, argv[0]))) {
360 return regshell_cmds[i].handle(ctx, argc, argv);
364 fprintf(stderr, "No such command '%s'\n", argv[0]);
366 return WERR_INVALID_PARAM;
369 #define MAX_COMPLETIONS 100
371 static struct registry_key *current_key = NULL;
373 static char **reg_complete_command(const char *text, int start, int end)
375 /* Complete command */
377 int i, len, samelen=0, count=1;
379 matches = malloc_array_p(char *, MAX_COMPLETIONS);
380 if (!matches) return NULL;
384 for (i=0;regshell_cmds[i].handle && count < MAX_COMPLETIONS-1;i++) {
385 if (strncmp(text, regshell_cmds[i].name, len) == 0) {
386 matches[count] = strdup(regshell_cmds[i].name);
390 samelen = strlen(matches[count]);
392 while (strncmp(matches[count], matches[count-1], samelen) != 0)
399 case 0: /* should never happen */
403 matches[0] = strdup(matches[1]);
406 matches[0] = strndup(matches[1], samelen);
408 matches[count] = NULL;
414 free(matches[count]);
421 static char **reg_complete_key(const char *text, int start, int end)
423 struct registry_key *base;
424 const char *subkeyname;
429 const char *base_n = "";
433 matches = malloc_array_p(char *, MAX_COMPLETIONS);
434 if (!matches) return NULL;
436 mem_ctx = talloc_init("completion");
441 for(i = 0; j < MAX_COMPLETIONS-1; i++) {
442 status = reg_key_get_subkey_by_index(mem_ctx, base, i,
443 &subkeyname, NULL, NULL);
444 if(W_ERROR_IS_OK(status)) {
445 if(!strncmp(text, subkeyname, len)) {
446 matches[j] = strdup(subkeyname);
450 samelen = strlen(matches[j]);
452 while (strncmp(matches[j], matches[j-1], samelen) != 0)
455 } else if(W_ERROR_EQUAL(status, WERR_NO_MORE_ITEMS)) {
458 printf("Error creating completion list: %s\n",
460 talloc_free(mem_ctx);
465 if (j == 1) { /* No matches at all */
467 talloc_free(mem_ctx);
471 if (j == 2) { /* Exact match */
472 asprintf(&matches[0], "%s%s", base_n, matches[1]);
474 asprintf(&matches[0], "%s%s", base_n,
475 talloc_strndup(mem_ctx, matches[1], samelen));
477 talloc_free(mem_ctx);
483 static char **reg_completion(const char *text, int start, int end)
485 smb_readline_ca_char(' ');
488 return reg_complete_command(text, start, end);
490 return reg_complete_key(text, start, end);
494 int main(int argc, char **argv)
497 const char *file = NULL;
499 const char *remote = NULL;
500 struct regshell_context *ctx;
502 struct poptOption long_options[] = {
504 {"file", 'F', POPT_ARG_STRING, &file, 0, "open hive file", NULL },
505 {"remote", 'R', POPT_ARG_STRING, &remote, 0, "connect to specified remote server", NULL},
507 POPT_COMMON_CREDENTIALS
512 pc = poptGetContext(argv[0], argc, (const char **) argv, long_options,0);
514 while((opt = poptGetNextOpt(pc)) != -1) {
517 ctx = talloc_zero(NULL, struct regshell_context);
519 if (remote != NULL) {
520 ctx->registry = reg_common_open_remote(remote, cmdline_lp_ctx,
521 cmdline_credentials);
522 } else if (file != NULL) {
523 ctx->current = reg_common_open_file(file, cmdline_lp_ctx, cmdline_credentials);
524 if (ctx->current == NULL)
526 ctx->registry = ctx->current->context;
527 ctx->path = talloc_strdup(ctx, "");
529 ctx->registry = reg_common_open_local(cmdline_credentials, cmdline_lp_ctx);
532 if (ctx->registry == NULL)
535 if (ctx->current == NULL) {
538 for (i = 0; reg_predefined_keys[i].handle; i++) {
540 err = reg_get_predefined_key(ctx->registry,
541 reg_predefined_keys[i].handle,
543 if (W_ERROR_IS_OK(err)) {
544 ctx->path = talloc_strdup(ctx,
545 reg_predefined_keys[i].name);
553 if (ctx->current == NULL) {
554 fprintf(stderr, "Unable to access any of the predefined keys\n");
563 asprintf(&prompt, "%s> ", ctx->path);
565 current_key = ctx->current; /* No way to pass a void * pointer
567 line = smb_readline(prompt, NULL, reg_completion);
574 if (line[0] != '\n') {
575 ret = W_ERROR_IS_OK(process_cmd(ctx, line));