Two useful "regshell" improvements
[nivanova/samba-autobuild/.git] / source / lib / registry / tools / regshell.c
1 /*
2    Unix SMB/CIFS implementation.
3    simple registry frontend
4
5    Copyright (C) Jelmer Vernooij 2004-2007
6
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.
11
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.
16
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/>.
19 */
20
21 #include "includes.h"
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"
30
31 struct regshell_context {
32         struct registry_context *registry;
33         const char *path;
34         struct registry_key *current;
35 };
36
37 /* *
38  * ck/cd - change key
39  * ls - list values/keys
40  * rmval/rm - remove value
41  * rmkey/rmdir - remove key
42  * mkkey/mkdir - make key
43  * ch - change hive
44  * info - show key info
45  * save - save hive
46  * print - print value
47  * help
48  * exit
49  */
50
51 static WERROR cmd_info(struct regshell_context *ctx, int argc, char **argv)
52 {
53         struct security_descriptor *sec_desc = NULL;
54         time_t last_mod;
55         WERROR error;
56         const char *classname = NULL;
57         NTTIME last_change;
58         uint32_t max_subkeynamelen;
59         uint32_t max_valnamelen;
60         uint32_t max_valbufsize;
61         uint32_t num_subkeys;
62         uint32_t num_values;
63
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));
68                 return error;
69         }
70
71
72         printf("Name: %s\n", strchr(ctx->path, '\\')?strrchr(ctx->path, '\\')+1:
73                    ctx->path);
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);
81
82         if (max_valnamelen > 0)
83                 printf("Maximum value name length: %d\n", max_valnamelen);
84
85         if (max_valbufsize > 0)
86                 printf("Maximum value data length: %d\n", max_valbufsize);
87
88         if (max_subkeynamelen > 0)
89                 printf("Maximum sub key name length: %d\n", max_subkeynamelen);
90
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");
94                 return error;
95         }
96         ndr_print_debug((ndr_print_fn_t)ndr_print_security_descriptor,
97                         "Security", sec_desc);
98         talloc_free(sec_desc);
99
100         return WERR_OK;
101 }
102
103 static WERROR cmd_predef(struct regshell_context *ctx, int argc, char **argv)
104 {
105         struct registry_key *ret = NULL;
106         if (argc < 2) {
107                 fprintf(stderr, "Usage: predef predefined-key-name\n");
108         } else if (!ctx) {
109                 fprintf(stderr, "No full registry loaded, no predefined keys defined\n");
110         } else {
111                 WERROR error = reg_get_predefined_key_by_name(ctx->registry,
112                                                               argv[1], &ret);
113
114                 if (!W_ERROR_IS_OK(error)) {
115                         fprintf(stderr, "Error opening predefined key %s: %s\n",
116                                 argv[1], win_errstr(error));
117                         return error;
118                 }
119
120                 ctx->path = strupper_talloc(ctx, argv[1]);
121                 ctx->current = ret;
122         }
123
124         return WERR_OK;
125 }
126
127 static WERROR cmd_pwd(struct regshell_context *ctx,
128                       int argc, char **argv)
129 {
130         printf("%s\n", ctx->path);
131         return WERR_OK;
132 }
133
134 static WERROR cmd_set(struct regshell_context *ctx, int argc, char **argv)
135 {
136         struct registry_value val;
137         WERROR error;
138
139         if (argc < 4) {
140                 fprintf(stderr, "Usage: set value-name type value\n");
141                 return WERR_INVALID_PARAM;
142         }
143
144         if (!reg_string_to_val(ctx, lp_iconv_convenience(cmdline_lp_ctx), 
145                                argv[2], argv[3], &val.data_type,
146                                &val.data)) {
147                 fprintf(stderr, "Unable to interpret data\n");
148                 return WERR_INVALID_PARAM;
149         }
150
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));
154                 return error;
155         }
156
157         return WERR_OK;
158 }
159
160 static WERROR cmd_ck(struct regshell_context *ctx, int argc, char **argv)
161 {
162         struct registry_key *new = NULL;
163         WERROR error;
164
165         if(argc == 2) {
166                 error = reg_open_key(ctx->registry, ctx->current, argv[1],
167                                      &new);
168                 if(!W_ERROR_IS_OK(error)) {
169                         DEBUG(0, ("Error opening specified key: %s\n",
170                                 win_errstr(error)));
171                         return error;
172                 }
173
174                 ctx->path = talloc_asprintf(ctx, "%s\\%s", ctx->path, argv[1]);
175                 ctx->current = new;
176         }
177         printf("New path is: %s\n", ctx->path);
178
179         return WERR_OK;
180 }
181
182 static WERROR cmd_print(struct regshell_context *ctx, int argc, char **argv)
183 {
184         uint32_t value_type;
185         DATA_BLOB value_data;
186         WERROR error;
187
188         if (argc != 2) {
189                 fprintf(stderr, "Usage: print <valuename>\n");
190                 return WERR_INVALID_PARAM;
191         }
192
193         error = reg_key_get_value_by_name(ctx, ctx->current, argv[1],
194                                           &value_type, &value_data);
195         if (!W_ERROR_IS_OK(error)) {
196                 fprintf(stderr, "No such value '%s'\n", argv[1]);
197                 return error;
198         }
199
200         printf("%s\n%s\n", str_regtype(value_type),
201                    reg_val_data_string(ctx, lp_iconv_convenience(cmdline_lp_ctx), value_type, value_data));
202
203         return WERR_OK;
204 }
205
206 static WERROR cmd_ls(struct regshell_context *ctx, int argc, char **argv)
207 {
208         int i;
209         WERROR error;
210         uint32_t data_type;
211         DATA_BLOB data;
212         const char *name = NULL;
213
214         for (i = 0; W_ERROR_IS_OK(error = reg_key_get_subkey_by_index(ctx,
215                                                                       ctx->current,
216                                                                       i,
217                                                                       &name,
218                                                                       NULL,
219                                                                       NULL)); i++) {
220                 printf("K %s\n", name);
221         }
222
223         if (!W_ERROR_EQUAL(error, WERR_NO_MORE_ITEMS)) {
224                 DEBUG(0, ("Error occured while browsing thru keys: %s\n",
225                         win_errstr(error)));
226         }
227
228         for (i = 0; W_ERROR_IS_OK(error = reg_key_get_value_by_index(ctx,
229                                                                      ctx->current,
230                                                                      i,
231                                                                      &name,
232                                                                      &data_type,
233                                                                      &data)); i++) {
234                 printf("V \"%s\" %s %s\n", name, str_regtype(data_type),
235                            reg_val_data_string(ctx, lp_iconv_convenience(cmdline_lp_ctx), data_type, data));
236         }
237
238         return WERR_OK;
239 }
240 static WERROR cmd_mkkey(struct regshell_context *ctx, int argc, char **argv)
241 {
242         struct registry_key *tmp;
243         WERROR error;
244
245         if(argc < 2) {
246                 fprintf(stderr, "Usage: mkkey <keyname>\n");
247                 return WERR_INVALID_PARAM;
248         }
249
250         error = reg_key_add_name(ctx, ctx->current, argv[1], 0, NULL, &tmp);
251
252         if (!W_ERROR_IS_OK(error)) {
253                 fprintf(stderr, "Error adding new subkey '%s'\n", argv[1]);
254                 return error;
255         }
256
257         return WERR_OK;
258 }
259
260 static WERROR cmd_rmkey(struct regshell_context *ctx,
261                         int argc, char **argv)
262 {
263         WERROR error;
264
265         if(argc < 2) {
266                 fprintf(stderr, "Usage: rmkey <name>\n");
267                 return WERR_INVALID_PARAM;
268         }
269
270         error = reg_key_del(ctx->current, argv[1]);
271         if(!W_ERROR_IS_OK(error)) {
272                 fprintf(stderr, "Error deleting '%s'\n", argv[1]);
273                 return error;
274         } else {
275                 fprintf(stderr, "Successfully deleted '%s'\n", argv[1]);
276         }
277
278         return WERR_OK;
279 }
280
281 static WERROR cmd_rmval(struct regshell_context *ctx, int argc, char **argv)
282 {
283         WERROR error;
284
285         if(argc < 2) {
286                 fprintf(stderr, "Usage: rmval <valuename>\n");
287                 return WERR_INVALID_PARAM;
288         }
289
290         error = reg_del_value(ctx->current, argv[1]);
291         if(!W_ERROR_IS_OK(error)) {
292                 fprintf(stderr, "Error deleting value '%s'\n", argv[1]);
293                 return error;
294         } else {
295                 fprintf(stderr, "Successfully deleted value '%s'\n", argv[1]);
296         }
297
298         return WERR_OK;
299 }
300
301 _NORETURN_ static WERROR cmd_exit(struct regshell_context *ctx,
302                                   int argc, char **argv)
303 {
304         exit(0);
305         return WERR_OK;
306 }
307
308 static WERROR cmd_help(struct regshell_context *ctx, int, char **);
309
310 static struct {
311         const char *name;
312         const char *alias;
313         const char *help;
314         WERROR (*handle)(struct regshell_context *ctx, int argc, char **argv);
315 } regshell_cmds[] = {
316         {"ck", "cd", "Change current key", cmd_ck },
317         {"info", "i", "Show detailed information of a key", cmd_info },
318         {"list", "ls", "List values/keys in current key", cmd_ls },
319         {"print", "p", "Print value", cmd_print },
320         {"mkkey", "mkdir", "Make new key", cmd_mkkey },
321         {"rmval", "rm", "Remove value", cmd_rmval },
322         {"rmkey", "rmdir", "Remove key", cmd_rmkey },
323         {"pwd", "pwk", "Printing current key", cmd_pwd },
324         {"set", "update", "Update value", cmd_set },
325         {"help", "?", "Help", cmd_help },
326         {"exit", "quit", "Exit", cmd_exit },
327         {"predef", "predefined", "Go to predefined key", cmd_predef },
328         {NULL }
329 };
330
331 static WERROR cmd_help(struct regshell_context *ctx,
332                        int argc, char **argv)
333 {
334         int i;
335         printf("Available commands:\n");
336         for(i = 0; regshell_cmds[i].name; i++) {
337                 printf("%s - %s\n", regshell_cmds[i].name,
338                         regshell_cmds[i].help);
339         }
340         return WERR_OK;
341 }
342
343 static WERROR process_cmd(struct regshell_context *ctx,
344                           char *line)
345 {
346         int argc;
347         char **argv = NULL;
348         int ret, i;
349
350         if ((ret = poptParseArgvString(line, &argc, (const char ***) &argv)) != 0) {
351                 fprintf(stderr, "regshell: %s\n", poptStrerror(ret));
352                 return WERR_INVALID_PARAM;
353         }
354
355         for(i = 0; regshell_cmds[i].name; i++) {
356                 if(!strcmp(regshell_cmds[i].name, argv[0]) ||
357                    (regshell_cmds[i].alias && !strcmp(regshell_cmds[i].alias, argv[0]))) {
358                         return regshell_cmds[i].handle(ctx, argc, argv);
359                 }
360         }
361
362         fprintf(stderr, "No such command '%s'\n", argv[0]);
363
364         return WERR_INVALID_PARAM;
365 }
366
367 #define MAX_COMPLETIONS 100
368
369 static struct registry_key *current_key = NULL;
370
371 static char **reg_complete_command(const char *text, int start, int end)
372 {
373         /* Complete command */
374         char **matches;
375         int i, len, samelen=0, count=1;
376
377         matches = malloc_array_p(char *, MAX_COMPLETIONS);
378         if (!matches) return NULL;
379         matches[0] = NULL;
380
381         len = strlen(text);
382         for (i=0;regshell_cmds[i].handle && count < MAX_COMPLETIONS-1;i++) {
383                 if (strncmp(text, regshell_cmds[i].name, len) == 0) {
384                         matches[count] = strdup(regshell_cmds[i].name);
385                         if (!matches[count])
386                                 goto cleanup;
387                         if (count == 1)
388                                 samelen = strlen(matches[count]);
389                         else
390                                 while (strncmp(matches[count], matches[count-1], samelen) != 0)
391                                         samelen--;
392                         count++;
393                 }
394         }
395
396         switch (count) {
397         case 0: /* should never happen */
398         case 1:
399                 goto cleanup;
400         case 2:
401                 matches[0] = strdup(matches[1]);
402                 break;
403         default:
404                 matches[0] = strndup(matches[1], samelen);
405         }
406         matches[count] = NULL;
407         return matches;
408
409 cleanup:
410         count--;
411         while (count >= 0) {
412                 free(matches[count]);
413                 count--;
414         }
415         free(matches);
416         return NULL;
417 }
418
419 static char **reg_complete_key(const char *text, int start, int end)
420 {
421         struct registry_key *base;
422         const char *subkeyname;
423         int i, j = 1;
424         int samelen = 0;
425         int len;
426         char **matches;
427         const char *base_n = "";
428         TALLOC_CTX *mem_ctx;
429         WERROR status;
430
431         matches = malloc_array_p(char *, MAX_COMPLETIONS);
432         if (!matches) return NULL;
433         matches[0] = NULL;
434         mem_ctx = talloc_init("completion");
435
436         base = current_key;
437
438         len = strlen(text);
439         for(i = 0; j < MAX_COMPLETIONS-1; i++) {
440                 status = reg_key_get_subkey_by_index(mem_ctx, base, i,
441                                                      &subkeyname, NULL, NULL);
442                 if(W_ERROR_IS_OK(status)) {
443                         if(!strncmp(text, subkeyname, len)) {
444                                 matches[j] = strdup(subkeyname);
445                                 j++;
446
447                                 if (j == 1)
448                                         samelen = strlen(matches[j]);
449                                 else
450                                         while (strncmp(matches[j], matches[j-1], samelen) != 0)
451                                                 samelen--;
452                         }
453                 } else if(W_ERROR_EQUAL(status, WERR_NO_MORE_ITEMS)) {
454                         break;
455                 } else {
456                         printf("Error creating completion list: %s\n",
457                                 win_errstr(status));
458                         talloc_free(mem_ctx);
459                         return NULL;
460                 }
461         }
462
463         if (j == 1) { /* No matches at all */
464                 SAFE_FREE(matches);
465                 talloc_free(mem_ctx);
466                 return NULL;
467         }
468
469         if (j == 2) { /* Exact match */
470                 asprintf(&matches[0], "%s%s", base_n, matches[1]);
471         } else {
472                 asprintf(&matches[0], "%s%s", base_n,
473                                 talloc_strndup(mem_ctx, matches[1], samelen));
474         }
475         talloc_free(mem_ctx);
476
477         matches[j] = NULL;
478         return matches;
479 }
480
481 static char **reg_completion(const char *text, int start, int end)
482 {
483         smb_readline_ca_char(' ');
484
485         if (start == 0) {
486                 return reg_complete_command(text, start, end);
487         } else {
488                 return reg_complete_key(text, start, end);
489         }
490 }
491
492 int main(int argc, char **argv)
493 {
494         int opt;
495         const char *file = NULL;
496         poptContext pc;
497         const char *remote = NULL;
498         struct regshell_context *ctx;
499         struct event_context *ev_ctx;
500         bool ret = true;
501         struct poptOption long_options[] = {
502                 POPT_AUTOHELP
503                 {"file", 'F', POPT_ARG_STRING, &file, 0, "open hive file", NULL },
504                 {"remote", 'R', POPT_ARG_STRING, &remote, 0, "connect to specified remote server", NULL},
505                 POPT_COMMON_SAMBA
506                 POPT_COMMON_CREDENTIALS
507                 POPT_COMMON_VERSION
508                 { NULL }
509         };
510
511         pc = poptGetContext(argv[0], argc, (const char **) argv, long_options,0);
512
513         while((opt = poptGetNextOpt(pc)) != -1) {
514         }
515
516         ctx = talloc_zero(NULL, struct regshell_context);
517
518         ev_ctx = s4_event_context_init(ctx);
519
520         if (remote != NULL) {
521                 ctx->registry = reg_common_open_remote(remote, cmdline_lp_ctx, 
522                                                        cmdline_credentials);
523         } else if (file != NULL) {
524                 ctx->current = reg_common_open_file(file, ev_ctx, cmdline_lp_ctx, cmdline_credentials);
525                 if (ctx->current == NULL)
526                         return 1;
527                 ctx->registry = ctx->current->context;
528                 ctx->path = talloc_strdup(ctx, "");
529         } else {
530                 ctx->registry = reg_common_open_local(cmdline_credentials, ev_ctx, cmdline_lp_ctx);
531         }
532
533         if (ctx->registry == NULL)
534                 return 1;
535
536         if (ctx->current == NULL) {
537                 int i;
538
539                 for (i = 0; reg_predefined_keys[i].handle; i++) {
540                         WERROR err;
541                         err = reg_get_predefined_key(ctx->registry,
542                                                      reg_predefined_keys[i].handle,
543                                                      &ctx->current);
544                         if (W_ERROR_IS_OK(err)) {
545                                 ctx->path = talloc_strdup(ctx,
546                                                           reg_predefined_keys[i].name);
547                                 break;
548                         } else {
549                                 ctx->current = NULL;
550                         }
551                 }
552         }
553
554         if (ctx->current == NULL) {
555                 fprintf(stderr, "Unable to access any of the predefined keys\n");
556                 return -1;
557         }
558
559         poptFreeContext(pc);
560
561         while (true) {
562                 char *line, *prompt;
563
564                 asprintf(&prompt, "%s> ", ctx->path);
565
566                 current_key = ctx->current;             /* No way to pass a void * pointer
567                                                            via readline :-( */
568                 line = smb_readline(prompt, NULL, reg_completion);
569
570                 if (line == NULL) {
571                         free(prompt);
572                         break;
573                 }
574
575                 if (line[0] != '\n') {
576                         ret = W_ERROR_IS_OK(process_cmd(ctx, line));
577                 }
578                 free(line);
579                 free(prompt);
580         }
581         talloc_free(ctx);
582
583         return (ret?0:1);
584 }