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 "lib/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
, 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(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
, 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\n", 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\n");
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
, 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
, char **argv
)
182 printf("%s\\", ctx
->predef
);
184 printf("%s\n", ctx
->path
);
188 static WERROR
cmd_set(struct regshell_context
*ctx
, int argc
, char **argv
)
190 struct registry_value val
;
194 fprintf(stderr
, "Usage: set value-name type value\n");
195 return WERR_INVALID_PARAM
;
198 if (!reg_string_to_val(ctx
, lp_iconv_convenience(cmdline_lp_ctx
),
199 argv
[2], argv
[3], &val
.data_type
,
201 fprintf(stderr
, "Unable to interpret data\n");
202 return WERR_INVALID_PARAM
;
205 error
= reg_val_set(ctx
->current
, argv
[1], val
.data_type
, val
.data
);
206 if (!W_ERROR_IS_OK(error
)) {
207 fprintf(stderr
, "Error setting value: %s\n", win_errstr(error
));
214 static WERROR
cmd_ck(struct regshell_context
*ctx
, int argc
, char **argv
)
216 struct registry_key
*nkey
= NULL
;
221 if (!W_ERROR_IS_OK(get_full_path(ctx
, argv
[1], &full_path
))) {
222 fprintf(stderr
, "Unable to parse the supplied path\n");
223 return WERR_INVALID_PARAM
;
225 error
= reg_open_key(ctx
->registry
, ctx
->root
, full_path
,
227 if(!W_ERROR_IS_OK(error
)) {
228 DEBUG(0, ("Error opening specified key: %s\n",
233 talloc_free(ctx
->path
);
234 ctx
->path
= full_path
;
238 printf("New path is: %s\\%s\n", ctx
->predef
?ctx
->predef
:"", ctx
->path
);
243 static WERROR
cmd_print(struct regshell_context
*ctx
, int argc
, char **argv
)
246 DATA_BLOB value_data
;
250 fprintf(stderr
, "Usage: print <valuename>\n");
251 return WERR_INVALID_PARAM
;
254 error
= reg_key_get_value_by_name(ctx
, ctx
->current
, argv
[1],
255 &value_type
, &value_data
);
256 if (!W_ERROR_IS_OK(error
)) {
257 fprintf(stderr
, "No such value '%s'\n", argv
[1]);
261 printf("%s\n%s\n", str_regtype(value_type
),
262 reg_val_data_string(ctx
, lp_iconv_convenience(cmdline_lp_ctx
), value_type
, value_data
));
267 static WERROR
cmd_ls(struct regshell_context
*ctx
, int argc
, char **argv
)
273 const char *name
= NULL
;
275 for (i
= 0; W_ERROR_IS_OK(error
= reg_key_get_subkey_by_index(ctx
,
281 printf("K %s\n", name
);
284 if (!W_ERROR_EQUAL(error
, WERR_NO_MORE_ITEMS
)) {
285 fprintf(stderr
, "Error occured while browsing thru keys: %s\n",
290 for (i
= 0; W_ERROR_IS_OK(error
= reg_key_get_value_by_index(ctx
,
291 ctx
->current
, i
, &name
, &valuetype
, &valuedata
)); i
++)
292 printf("V \"%s\" %s %s\n", name
, str_regtype(valuetype
),
293 reg_val_data_string(ctx
, lp_iconv_convenience(cmdline_lp_ctx
), valuetype
, valuedata
));
297 static WERROR
cmd_mkkey(struct regshell_context
*ctx
, int argc
, char **argv
)
299 struct registry_key
*tmp
;
303 fprintf(stderr
, "Usage: mkkey <keyname>\n");
304 return WERR_INVALID_PARAM
;
307 error
= reg_key_add_name(ctx
, ctx
->current
, argv
[1], 0, NULL
, &tmp
);
309 if (!W_ERROR_IS_OK(error
)) {
310 fprintf(stderr
, "Error adding new subkey '%s': %s\n", argv
[1],
318 static WERROR
cmd_rmkey(struct regshell_context
*ctx
,
319 int argc
, char **argv
)
324 fprintf(stderr
, "Usage: rmkey <name>\n");
325 return WERR_INVALID_PARAM
;
328 error
= reg_key_del(ctx
->current
, argv
[1]);
329 if(!W_ERROR_IS_OK(error
)) {
330 fprintf(stderr
, "Error deleting '%s'\n", argv
[1]);
333 fprintf(stderr
, "Successfully deleted '%s'\n", argv
[1]);
339 static WERROR
cmd_rmval(struct regshell_context
*ctx
, int argc
, char **argv
)
344 fprintf(stderr
, "Usage: rmval <valuename>\n");
345 return WERR_INVALID_PARAM
;
348 error
= reg_del_value(ctx
->current
, argv
[1]);
349 if(!W_ERROR_IS_OK(error
)) {
350 fprintf(stderr
, "Error deleting value '%s'\n", argv
[1]);
353 fprintf(stderr
, "Successfully deleted value '%s'\n", argv
[1]);
359 _NORETURN_
static WERROR
cmd_exit(struct regshell_context
*ctx
,
360 int argc
, char **argv
)
365 static WERROR
cmd_help(struct regshell_context
*ctx
, int, char **);
371 WERROR (*handle
)(struct regshell_context
*ctx
, int argc
, char **argv
);
372 } regshell_cmds
[] = {
373 {"ck", "cd", "Change current key", cmd_ck
},
374 {"info", "i", "Show detailed information of a key", cmd_info
},
375 {"list", "ls", "List values/keys in current key", cmd_ls
},
376 {"print", "p", "Print value", cmd_print
},
377 {"mkkey", "mkdir", "Make new key", cmd_mkkey
},
378 {"rmval", "rm", "Remove value", cmd_rmval
},
379 {"rmkey", "rmdir", "Remove key", cmd_rmkey
},
380 {"pwd", "pwk", "Printing current key", cmd_pwd
},
381 {"set", "update", "Update value", cmd_set
},
382 {"help", "?", "Help", cmd_help
},
383 {"exit", "quit", "Exit", cmd_exit
},
384 {"predef", "predefined", "Go to predefined key", cmd_predef
},
388 static WERROR
cmd_help(struct regshell_context
*ctx
,
389 int argc
, char **argv
)
392 printf("Available commands:\n");
393 for(i
= 0; regshell_cmds
[i
].name
; i
++) {
394 printf("%s - %s\n", regshell_cmds
[i
].name
,
395 regshell_cmds
[i
].help
);
400 static WERROR
process_cmd(struct regshell_context
*ctx
,
407 if ((ret
= poptParseArgvString(line
, &argc
, (const char ***) &argv
)) != 0) {
408 fprintf(stderr
, "regshell: %s\n", poptStrerror(ret
));
409 return WERR_INVALID_PARAM
;
412 for(i
= 0; regshell_cmds
[i
].name
; i
++) {
413 if(!strcmp(regshell_cmds
[i
].name
, argv
[0]) ||
414 (regshell_cmds
[i
].alias
&& !strcmp(regshell_cmds
[i
].alias
, argv
[0]))) {
415 return regshell_cmds
[i
].handle(ctx
, argc
, argv
);
419 fprintf(stderr
, "No such command '%s'\n", argv
[0]);
421 return WERR_INVALID_PARAM
;
424 #define MAX_COMPLETIONS 100
426 static struct registry_key
*current_key
= NULL
;
428 static char **reg_complete_command(const char *text
, int start
, int end
)
430 /* Complete command */
432 int i
, len
, samelen
=0, count
=1;
434 matches
= malloc_array_p(char *, MAX_COMPLETIONS
);
435 if (!matches
) return NULL
;
439 for (i
=0;regshell_cmds
[i
].handle
&& count
< MAX_COMPLETIONS
-1;i
++) {
440 if (strncmp(text
, regshell_cmds
[i
].name
, len
) == 0) {
441 matches
[count
] = strdup(regshell_cmds
[i
].name
);
445 samelen
= strlen(matches
[count
]);
447 while (strncmp(matches
[count
], matches
[count
-1], samelen
) != 0)
454 case 0: /* should never happen */
458 matches
[0] = strdup(matches
[1]);
461 matches
[0] = strndup(matches
[1], samelen
);
463 matches
[count
] = NULL
;
469 free(matches
[count
]);
476 static char **reg_complete_key(const char *text
, int start
, int end
)
478 struct registry_key
*base
;
479 const char *subkeyname
;
484 const char *base_n
= "";
488 matches
= malloc_array_p(char *, MAX_COMPLETIONS
);
489 if (!matches
) return NULL
;
491 mem_ctx
= talloc_init("completion");
496 for(i
= 0; j
< MAX_COMPLETIONS
-1; i
++) {
497 status
= reg_key_get_subkey_by_index(mem_ctx
, base
, i
,
498 &subkeyname
, NULL
, NULL
);
499 if(W_ERROR_IS_OK(status
)) {
500 if(!strncmp(text
, subkeyname
, len
)) {
501 matches
[j
] = strdup(subkeyname
);
505 samelen
= strlen(matches
[j
]);
507 while (strncmp(matches
[j
], matches
[j
-1], samelen
) != 0)
510 } else if(W_ERROR_EQUAL(status
, WERR_NO_MORE_ITEMS
)) {
513 printf("Error creating completion list: %s\n",
515 talloc_free(mem_ctx
);
520 if (j
== 1) { /* No matches at all */
522 talloc_free(mem_ctx
);
526 if (j
== 2) { /* Exact match */
527 asprintf(&matches
[0], "%s%s", base_n
, matches
[1]);
529 asprintf(&matches
[0], "%s%s", base_n
,
530 talloc_strndup(mem_ctx
, matches
[1], samelen
));
532 talloc_free(mem_ctx
);
538 static char **reg_completion(const char *text
, int start
, int end
)
540 smb_readline_ca_char(' ');
543 return reg_complete_command(text
, start
, end
);
545 return reg_complete_key(text
, start
, end
);
549 int main(int argc
, char **argv
)
552 const char *file
= NULL
;
554 const char *remote
= NULL
;
555 struct regshell_context
*ctx
;
556 struct tevent_context
*ev_ctx
;
558 struct poptOption long_options
[] = {
560 {"file", 'F', POPT_ARG_STRING
, &file
, 0, "open hive file", NULL
},
561 {"remote", 'R', POPT_ARG_STRING
, &remote
, 0, "connect to specified remote server", NULL
},
563 POPT_COMMON_CREDENTIALS
568 pc
= poptGetContext(argv
[0], argc
, (const char **) argv
, long_options
,0);
570 while((opt
= poptGetNextOpt(pc
)) != -1) {
573 ctx
= talloc_zero(NULL
, struct regshell_context
);
575 ev_ctx
= s4_event_context_init(ctx
);
577 if (remote
!= NULL
) {
578 ctx
->registry
= reg_common_open_remote(remote
, ev_ctx
,
579 cmdline_lp_ctx
, cmdline_credentials
);
580 } else if (file
!= NULL
) {
581 ctx
->current
= reg_common_open_file(file
, ev_ctx
, cmdline_lp_ctx
, cmdline_credentials
);
582 if (ctx
->current
== NULL
)
584 ctx
->registry
= ctx
->current
->context
;
585 ctx
->path
= talloc_strdup(ctx
, "");
587 ctx
->root
= ctx
->current
;
589 ctx
->registry
= reg_common_open_local(cmdline_credentials
, ev_ctx
, cmdline_lp_ctx
);
592 if (ctx
->registry
== NULL
)
595 if (ctx
->current
== NULL
) {
598 for (i
= 0; (reg_predefined_keys
[i
].handle
!= 0) &&
599 (ctx
->current
== NULL
); i
++) {
601 err
= reg_get_predefined_key(ctx
->registry
,
602 reg_predefined_keys
[i
].handle
,
604 if (W_ERROR_IS_OK(err
)) {
605 ctx
->predef
= talloc_strdup(ctx
,
606 reg_predefined_keys
[i
].name
);
607 ctx
->path
= talloc_strdup(ctx
, "");
608 ctx
->root
= ctx
->current
;
617 if (ctx
->current
== NULL
) {
618 fprintf(stderr
, "Unable to access any of the predefined keys\n");
627 asprintf(&prompt
, "%s\\%s> ", ctx
->predef
?ctx
->predef
:"", ctx
->path
);
629 current_key
= ctx
->current
; /* No way to pass a void * pointer
631 line
= smb_readline(prompt
, NULL
, reg_completion
);
638 if (line
[0] != '\n') {
639 ret
= W_ERROR_IS_OK(process_cmd(ctx
, line
));