2 Unix SMB/CIFS implementation.
3 simple registry frontend
5 Copyright (C) Jelmer Vernooij 2004-2007
6 Copyright (C) Wilco Baan Hofman 2009
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "lib/registry/registry.h"
24 #include "lib/cmdline/popt_common.h"
25 #include "lib/events/events.h"
26 #include "system/time.h"
27 #include "../libcli/smbreadline/smbreadline.h"
28 #include "librpc/gen_ndr/ndr_security.h"
29 #include "lib/registry/tools/common.h"
30 #include "param/param.h"
32 struct regshell_context {
33 struct registry_context *registry;
36 struct registry_key *current;
37 struct registry_key *root;
40 static WERROR get_full_path(struct regshell_context *ctx, const char *path, char **ret_path)
46 if (path[0] == '\\') {
47 new_path = talloc_strdup(ctx, "");
49 new_path = talloc_strdup(ctx, ctx->path);
52 dir = strtok(discard_const_p(char, path), "\\");
58 if (strcmp(dir, "..") == 0) {
59 if (strchr(new_path, '\\')) {
60 new_path[strrchr(new_path, '\\') - new_path] = '\0';
63 new_path = talloc_strdup(ctx, "");
68 if (strcmp(dir, ".") == 0) {
73 /* No prepending a backslash */
74 if (strcmp(new_path, "") == 0) {
75 new_path = talloc_strdup(ctx, dir);
77 new_path = talloc_asprintf(ctx, "%s\\%s", new_path, dir);
81 } while ((dir = strtok(NULL, "\\")));
89 * ls - list values/keys
90 * rmval/rm - remove value
91 * rmkey/rmdir - remove key
92 * mkkey/mkdir - make key
94 * info - show key info
101 static WERROR cmd_info(struct regshell_context *ctx, int argc, const char **argv)
103 struct security_descriptor *sec_desc = NULL;
106 const char *classname = NULL;
108 uint32_t max_subkeynamelen;
109 uint32_t max_valnamelen;
110 uint32_t max_valbufsize;
111 uint32_t num_subkeys;
114 error = reg_key_get_info(ctx, ctx->current, &classname, &num_subkeys, &num_values,
115 &last_change, &max_subkeynamelen, &max_valnamelen, &max_valbufsize);
116 if (!W_ERROR_IS_OK(error)) {
117 printf("Error getting key info: %s\n", win_errstr(error));
122 printf("Name: %s\n", strchr(ctx->path, '\\')?strrchr(ctx->path, '\\')+1:
124 printf("Full path: %s\n", ctx->path);
125 if (classname != NULL)
126 printf("Key Class: %s\n", classname);
127 last_mod = nt_time_to_unix(last_change);
128 printf("Time Last Modified: %s", ctime(&last_mod));
129 printf("Number of subkeys: %d\n", num_subkeys);
130 printf("Number of values: %d\n", num_values);
132 if (max_valnamelen > 0)
133 printf("Maximum value name length: %d\n", max_valnamelen);
135 if (max_valbufsize > 0)
136 printf("Maximum value data length: %d\n", max_valbufsize);
138 if (max_subkeynamelen > 0)
139 printf("Maximum sub key name length: %d\n", max_subkeynamelen);
141 error = reg_get_sec_desc(ctx, ctx->current, &sec_desc);
142 if (!W_ERROR_IS_OK(error)) {
143 printf("Error getting security descriptor: %s\n", win_errstr(error));
146 ndr_print_debug((ndr_print_fn_t)ndr_print_security_descriptor,
147 "Security", sec_desc);
148 talloc_free(sec_desc);
153 static WERROR cmd_predef(struct regshell_context *ctx, int argc, const char **argv)
155 struct registry_key *ret = NULL;
157 fprintf(stderr, "Usage: predef predefined-key-name\n");
159 fprintf(stderr, "No full registry loaded, no predefined keys defined\n");
161 WERROR error = reg_get_predefined_key_by_name(ctx->registry,
164 if (!W_ERROR_IS_OK(error)) {
165 fprintf(stderr, "Error opening predefined key %s: %s\n",
166 argv[1], win_errstr(error));
170 ctx->predef = strupper_talloc(ctx, argv[1]);
178 static WERROR cmd_pwd(struct regshell_context *ctx,
179 int argc, const char **argv)
182 printf("%s\\", ctx->predef);
184 printf("%s\n", ctx->path);
188 static WERROR cmd_set(struct regshell_context *ctx, int argc, const char **argv)
190 struct registry_value val;
194 fprintf(stderr, "Usage: set value-name type value\n");
195 return WERR_INVALID_PARAMETER;
198 if (!reg_string_to_val(ctx, argv[2], argv[3], &val.data_type, &val.data)) {
199 fprintf(stderr, "Unable to interpret data\n");
200 return WERR_INVALID_PARAMETER;
203 error = reg_val_set(ctx->current, argv[1], val.data_type, val.data);
204 if (!W_ERROR_IS_OK(error)) {
205 fprintf(stderr, "Error setting value: %s\n", win_errstr(error));
212 static WERROR cmd_ck(struct regshell_context *ctx, int argc, const char **argv)
214 struct registry_key *nkey = NULL;
219 if (!W_ERROR_IS_OK(get_full_path(ctx, argv[1], &full_path))) {
220 fprintf(stderr, "Unable to parse the supplied path\n");
221 return WERR_INVALID_PARAMETER;
223 error = reg_open_key(ctx->registry, ctx->root, full_path,
225 if(!W_ERROR_IS_OK(error)) {
226 DEBUG(0, ("Error opening specified key: %s\n",
231 talloc_free(ctx->path);
232 ctx->path = full_path;
236 printf("New path is: %s\\%s\n", ctx->predef?ctx->predef:"", ctx->path);
241 static WERROR cmd_print(struct regshell_context *ctx, int argc, const char **argv)
244 DATA_BLOB value_data;
248 fprintf(stderr, "Usage: print <valuename>\n");
249 return WERR_INVALID_PARAMETER;
252 error = reg_key_get_value_by_name(ctx, ctx->current, argv[1],
253 &value_type, &value_data);
254 if (!W_ERROR_IS_OK(error)) {
255 fprintf(stderr, "No such value '%s'\n", argv[1]);
259 printf("%s\n%s\n", str_regtype(value_type),
260 reg_val_data_string(ctx, value_type, value_data));
265 static WERROR cmd_ls(struct regshell_context *ctx, int argc, const char **argv)
271 const char *name = NULL;
273 for (i = 0; W_ERROR_IS_OK(error = reg_key_get_subkey_by_index(ctx,
279 printf("K %s\n", name);
282 if (!W_ERROR_EQUAL(error, WERR_NO_MORE_ITEMS)) {
283 fprintf(stderr, "Error occurred while browsing through keys: %s\n",
288 for (i = 0; W_ERROR_IS_OK(error = reg_key_get_value_by_index(ctx,
289 ctx->current, i, &name, &valuetype, &valuedata)); i++)
290 printf("V \"%s\" %s %s\n", name, str_regtype(valuetype),
291 reg_val_data_string(ctx, valuetype, valuedata));
295 static WERROR cmd_mkkey(struct regshell_context *ctx, int argc, const char **argv)
297 struct registry_key *tmp;
301 fprintf(stderr, "Usage: mkkey <keyname>\n");
302 return WERR_INVALID_PARAMETER;
305 error = reg_key_add_name(ctx, ctx->current, argv[1], 0, NULL, &tmp);
307 if (!W_ERROR_IS_OK(error)) {
308 fprintf(stderr, "Error adding new subkey '%s': %s\n", argv[1],
316 static WERROR cmd_rmkey(struct regshell_context *ctx,
317 int argc, const char **argv)
322 fprintf(stderr, "Usage: rmkey <name>\n");
323 return WERR_INVALID_PARAMETER;
326 error = reg_key_del(ctx, ctx->current, argv[1]);
327 if(!W_ERROR_IS_OK(error)) {
328 fprintf(stderr, "Error deleting '%s'\n", argv[1]);
331 fprintf(stderr, "Successfully deleted '%s'\n", argv[1]);
337 static WERROR cmd_rmval(struct regshell_context *ctx, int argc, const char **argv)
342 fprintf(stderr, "Usage: rmval <valuename>\n");
343 return WERR_INVALID_PARAMETER;
346 error = reg_del_value(ctx, ctx->current, argv[1]);
347 if(!W_ERROR_IS_OK(error)) {
348 fprintf(stderr, "Error deleting value '%s'\n", argv[1]);
351 fprintf(stderr, "Successfully deleted value '%s'\n", argv[1]);
357 _NORETURN_ static WERROR cmd_exit(struct regshell_context *ctx,
358 int argc, const char **argv)
363 static WERROR cmd_help(struct regshell_context *ctx, int, const char **);
369 WERROR (*handle)(struct regshell_context *ctx, int argc, const char **argv);
370 } regshell_cmds[] = {
371 {"ck", "cd", "Change current key", cmd_ck },
372 {"info", "i", "Show detailed information of a key", cmd_info },
373 {"list", "ls", "List values/keys in current key", cmd_ls },
374 {"print", "p", "Print value", cmd_print },
375 {"mkkey", "mkdir", "Make new key", cmd_mkkey },
376 {"rmval", "rm", "Remove value", cmd_rmval },
377 {"rmkey", "rmdir", "Remove key", cmd_rmkey },
378 {"pwd", "pwk", "Printing current key", cmd_pwd },
379 {"set", "update", "Update value", cmd_set },
380 {"help", "?", "Help", cmd_help },
381 {"exit", "quit", "Exit", cmd_exit },
382 {"predef", "predefined", "Go to predefined key", cmd_predef },
386 static WERROR cmd_help(struct regshell_context *ctx,
387 int argc, const char **argv)
390 printf("Available commands:\n");
391 for(i = 0; regshell_cmds[i].name; i++) {
392 printf("%s - %s\n", regshell_cmds[i].name,
393 regshell_cmds[i].help);
398 static WERROR process_cmd(struct regshell_context *ctx,
402 const char **argv = NULL;
405 if ((ret = poptParseArgvString(line, &argc, &argv)) != 0) {
406 fprintf(stderr, "regshell: %s\n", poptStrerror(ret));
407 return WERR_INVALID_PARAMETER;
410 for(i = 0; regshell_cmds[i].name; i++) {
411 if(!strcmp(regshell_cmds[i].name, argv[0]) ||
412 (regshell_cmds[i].alias && !strcmp(regshell_cmds[i].alias, argv[0]))) {
413 return regshell_cmds[i].handle(ctx, argc, argv);
417 fprintf(stderr, "No such command '%s'\n", argv[0]);
419 return WERR_INVALID_PARAMETER;
422 #define MAX_COMPLETIONS 100
424 static struct registry_key *current_key = NULL;
426 static char **reg_complete_command(const char *text, int start, int end)
428 /* Complete command */
430 size_t len, samelen=0;
433 matches = malloc_array_p(char *, MAX_COMPLETIONS);
434 if (!matches) return NULL;
438 for (i=0;regshell_cmds[i].handle && count < MAX_COMPLETIONS-1;i++) {
439 if (strncmp(text, regshell_cmds[i].name, len) == 0) {
440 matches[count] = strdup(regshell_cmds[i].name);
444 samelen = strlen(matches[count]);
446 while (strncmp(matches[count], matches[count-1], samelen) != 0)
453 case 0: /* should never happen */
457 matches[0] = strdup(matches[1]);
460 matches[0] = strndup(matches[1], samelen);
462 matches[count] = NULL;
466 for (i = 0; i < count; i++) {
473 static char **reg_complete_key(const char *text, int start, int end)
475 struct registry_key *base;
476 const char *subkeyname;
477 unsigned int i, j = 1;
478 size_t len, samelen = 0;
480 const char *base_n = "";
485 matches = malloc_array_p(char *, MAX_COMPLETIONS);
486 if (!matches) return NULL;
488 mem_ctx = talloc_init("completion");
493 for(i = 0; j < MAX_COMPLETIONS-1; i++) {
494 status = reg_key_get_subkey_by_index(mem_ctx, base, i,
495 &subkeyname, NULL, NULL);
496 if(W_ERROR_IS_OK(status)) {
497 if(!strncmp(text, subkeyname, len)) {
498 matches[j] = strdup(subkeyname);
502 samelen = strlen(matches[j]);
504 while (strncmp(matches[j], matches[j-1], samelen) != 0)
507 } else if(W_ERROR_EQUAL(status, WERR_NO_MORE_ITEMS)) {
512 printf("Error creating completion list: %s\n",
515 for (n = j; n >= 0; n--) {
516 SAFE_FREE(matches[n]);
519 talloc_free(mem_ctx);
524 if (j == 1) { /* No matches at all */
526 talloc_free(mem_ctx);
530 if (j == 2) { /* Exact match */
531 ret = asprintf(&matches[0], "%s%s", base_n, matches[1]);
533 ret = asprintf(&matches[0], "%s%s", base_n,
534 talloc_strndup(mem_ctx, matches[1], samelen));
536 talloc_free(mem_ctx);
546 static char **reg_completion(const char *text, int start, int end)
548 smb_readline_ca_char(' ');
551 return reg_complete_command(text, start, end);
553 return reg_complete_key(text, start, end);
557 int main(int argc, const char **argv)
560 const char *file = NULL;
562 const char *remote = NULL;
563 struct regshell_context *ctx;
564 struct tevent_context *ev_ctx;
566 struct poptOption long_options[] = {
568 {"file", 'F', POPT_ARG_STRING, &file, 0, "open hive file", NULL },
569 {"remote", 'R', POPT_ARG_STRING, &remote, 0, "connect to specified remote server", NULL},
571 POPT_COMMON_CREDENTIALS
576 pc = poptGetContext(argv[0], argc, argv, long_options,0);
578 while((opt = poptGetNextOpt(pc)) != -1) {
581 ctx = talloc_zero(NULL, struct regshell_context);
583 ev_ctx = s4_event_context_init(ctx);
585 if (remote != NULL) {
586 ctx->registry = reg_common_open_remote(remote, ev_ctx,
588 popt_get_cmdline_credentials());
589 } else if (file != NULL) {
590 ctx->current = reg_common_open_file(file, ev_ctx,
592 popt_get_cmdline_credentials());
593 if (ctx->current == NULL)
595 ctx->registry = ctx->current->context;
596 ctx->path = talloc_strdup(ctx, "");
598 ctx->root = ctx->current;
600 ctx->registry = reg_common_open_local(
601 popt_get_cmdline_credentials(),
602 ev_ctx, cmdline_lp_ctx);
605 if (ctx->registry == NULL)
608 if (ctx->current == NULL) {
611 for (i = 0; (reg_predefined_keys[i].handle != 0) &&
612 (ctx->current == NULL); i++) {
614 err = reg_get_predefined_key(ctx->registry,
615 reg_predefined_keys[i].handle,
617 if (W_ERROR_IS_OK(err)) {
618 ctx->predef = talloc_strdup(ctx,
619 reg_predefined_keys[i].name);
620 ctx->path = talloc_strdup(ctx, "");
621 ctx->root = ctx->current;
630 if (ctx->current == NULL) {
631 fprintf(stderr, "Unable to access any of the predefined keys\n");
640 if (asprintf(&prompt, "%s\\%s> ", ctx->predef?ctx->predef:"",
646 current_key = ctx->current; /* No way to pass a void * pointer
648 line = smb_readline(prompt, NULL, reg_completion);
655 if (line[0] != '\n') {
656 ret = W_ERROR_IS_OK(process_cmd(ctx, line));