2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 2003
5 Copyright (C) Jelmer Vernooij 2006
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 "system/filesys.h"
23 #include "system/locale.h"
24 #include "librpc/ndr/libndr.h"
25 #include "librpc/ndr/ndr_table.h"
26 #include "librpc/gen_ndr/ndr_dcerpc.h"
27 #include "lib/cmdline/popt_common.h"
28 #include "param/param.h"
29 #include "lib/util/base64.h"
31 static const struct ndr_interface_call *find_function(
32 const struct ndr_interface_table *p,
36 if (isdigit(function[0])) {
38 i = strtoul(function, &eptr, 0);
42 printf("Function number '%s' not found\n",
48 for (i=0;i<p->num_calls;i++) {
49 if (strcmp(p->calls[i].name, function) == 0) {
53 if (i == p->num_calls) {
54 printf("Function '%s' not found\n", function);
61 * Find a public structure on the pipe and return it as if it were
62 * a function (as the rest of ndrdump is based around functions)
64 static const struct ndr_interface_call *find_struct(
65 const struct ndr_interface_table *p,
66 const char *struct_name,
67 struct ndr_interface_call *out_buffer)
70 const struct ndr_interface_public_struct *public_struct = NULL;
71 if (isdigit(struct_name[0])) {
73 i = strtoul(struct_name, &eptr, 0);
74 if (i >= p->num_public_structs
77 printf("Public structure number '%s' not found\n",
81 public_struct = &p->public_structs[i];
83 for (i=0;i<p->num_public_structs;i++) {
84 if (strcmp(p->public_structs[i].name, struct_name) == 0) {
88 if (i == p->num_public_structs) {
89 printf("Public structure '%s' not found\n", struct_name);
92 public_struct = &p->public_structs[i];
94 *out_buffer = (struct ndr_interface_call) {
95 .name = public_struct->name,
96 .struct_size = public_struct->struct_size,
97 .ndr_pull = public_struct->ndr_pull,
98 .ndr_push = public_struct->ndr_push,
99 .ndr_print = public_struct->ndr_print
104 _NORETURN_ static void show_pipes(void)
106 const struct ndr_interface_list *l;
107 printf("\nYou must specify a pipe\n");
108 printf("known pipes are:\n");
109 for (l=ndr_table_list();l;l=l->next) {
110 if(l->table->helpstring) {
111 printf("\t%s - %s\n", l->table->name, l->table->helpstring);
113 printf("\t%s\n", l->table->name);
119 _NORETURN_ static void show_functions(const struct ndr_interface_table *p)
122 printf("\nYou must specify a function\n");
123 printf("known functions on '%s' are:\n", p->name);
124 for (i=0;i<p->num_calls;i++) {
125 printf("\t0x%02x (%2d) %s\n", i, i, p->calls[i].name);
127 printf("known public structures on '%s' are:\n", p->name);
128 for (i=0;i<p->num_public_structs;i++) {
129 printf("\t%s\n", p->public_structs[i].name);
134 static char *stdin_load(TALLOC_CTX *mem_ctx, size_t *size)
136 int num_read, total_len = 0;
140 while((num_read = read(STDIN_FILENO, buf, 255)) > 0) {
143 result = talloc_realloc(
144 mem_ctx, result, char, total_len + num_read);
146 result = talloc_array(mem_ctx, char, num_read);
149 memcpy(result + total_len, buf, num_read);
151 total_len += num_read;
160 static const struct ndr_interface_table *load_iface_from_plugin(const char *plugin, const char *pipe_name)
162 const struct ndr_interface_table *p;
166 handle = dlopen(plugin, RTLD_NOW);
167 if (handle == NULL) {
168 printf("%s: Unable to open: %s\n", plugin, dlerror());
172 symbol = talloc_asprintf(NULL, "ndr_table_%s", pipe_name);
173 p = (const struct ndr_interface_table *)dlsym(handle, symbol);
176 printf("%s: Unable to find DCE/RPC interface table for '%s': %s\n", plugin, pipe_name, dlerror());
187 static void ndrdump_data(uint8_t *d, uint32_t l, bool force)
189 dump_data_file(d, l, !force, stdout);
192 static NTSTATUS ndrdump_pull_and_print_pipes(const char *function,
193 struct ndr_pull *ndr_pull,
194 struct ndr_print *ndr_print,
195 const struct ndr_interface_call_pipes *pipes)
197 enum ndr_err_code ndr_err;
200 for (i=0; i < pipes->num_pipes; i++) {
208 c = talloc_zero_size(ndr_pull, pipes->pipes[i].chunk_struct_size);
209 talloc_set_name(c, "struct %s", pipes->pipes[i].name);
211 * Note: the first struct member is always
214 count = (uint32_t *)c;
216 n = talloc_asprintf(c, "%s: %s[%llu]",
217 function, pipes->pipes[i].name,
218 (unsigned long long)idx);
220 saved_mem_ctx = ndr_pull->current_mem_ctx;
221 ndr_pull->current_mem_ctx = c;
222 ndr_err = pipes->pipes[i].ndr_pull(ndr_pull, NDR_SCALARS, c);
223 ndr_pull->current_mem_ctx = saved_mem_ctx;
225 printf("pull returned %s\n",
226 ndr_map_error2string(ndr_err));
227 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
229 return ndr_map_error2ntstatus(ndr_err);
231 pipes->pipes[i].ndr_print(ndr_print, n, c);
244 static void ndr_print_dummy(struct ndr_print *ndr, const char *format, ...)
246 /* This is here so that you can turn ndr printing off for the purposes
247 of benchmarking ndr parsing. */
250 int main(int argc, const char *argv[])
252 const struct ndr_interface_table *p = NULL;
253 const struct ndr_interface_call *f;
254 struct ndr_interface_call f_buffer;
255 const char *pipe_name = NULL;
256 const char *filename = NULL;
261 * struct: a public structure
263 const char *type = NULL;
265 * Format is either the name of the decoding function or the
266 * name of a public structure
268 const char *format = NULL;
269 const char *cmdline_input = NULL;
273 struct ndr_pull *ndr_pull;
274 struct ndr_print *ndr_print;
279 enum ndr_err_code ndr_err;
282 const char *ctx_filename = NULL;
283 const char *plugin = NULL;
284 bool validate = false;
285 bool dumpdata = false;
286 bool assume_ndr64 = false;
288 bool hex_input = false;
289 bool base64_input = false;
290 bool print_after_parse_failure = false;
293 OPT_CONTEXT_FILE=1000,
302 OPT_PRINT_AFTER_PARSE_FAILURE,
304 struct poptOption long_options[] = {
306 {"context-file", 'c', POPT_ARG_STRING, NULL, OPT_CONTEXT_FILE, "In-filename to parse first", "CTX-FILE" },
307 {"validate", 0, POPT_ARG_NONE, NULL, OPT_VALIDATE, "try to validate the data", NULL },
308 {"dump-data", 0, POPT_ARG_NONE, NULL, OPT_DUMP_DATA, "dump the hex data", NULL },
309 {"load-dso", 'l', POPT_ARG_STRING, NULL, OPT_LOAD_DSO, "load from shared object file", NULL },
310 {"ndr64", 0, POPT_ARG_NONE, NULL, OPT_NDR64, "Assume NDR64 data", NULL },
311 {"quiet", 0, POPT_ARG_NONE, NULL, OPT_QUIET, "Don't actually dump anything", NULL },
312 {"base64-input", 0, POPT_ARG_NONE, NULL, OPT_BASE64_INPUT, "Read the input file in as a base64 string", NULL },
313 {"hex-input", 0, POPT_ARG_NONE, NULL, OPT_HEX_INPUT, "Read the input file in as a hex dump", NULL },
314 {"input", 0, POPT_ARG_STRING, NULL, OPT_CMDLINE_INPUT, "Provide the input on the command line (use with --base64-input)", "INPUT" },
315 {"print-after-parse-failure", 0, POPT_ARG_NONE, NULL, OPT_PRINT_AFTER_PARSE_FAILURE,
316 "Try to print structures that fail to parse (used to develop parsers, segfaults are likely).", NULL },
321 uint32_t highest_ofs;
322 struct dcerpc_sec_verification_trailer *sec_vt = NULL;
326 /* Initialise samba stuff */
331 setup_logging("ndrdump", DEBUG_STDOUT);
333 pc = poptGetContext("ndrdump", argc, argv, long_options, 0);
335 poptSetOtherOptionHelp(
336 pc, "<pipe|uuid> <format> <in|out|struct> [<filename>]");
338 while ((opt = poptGetNextOpt(pc)) != -1) {
340 case OPT_CONTEXT_FILE:
341 ctx_filename = poptGetOptArg(pc);
350 plugin = poptGetOptArg(pc);
358 case OPT_BASE64_INPUT:
364 case OPT_CMDLINE_INPUT:
365 cmdline_input = poptGetOptArg(pc);
367 case OPT_PRINT_AFTER_PARSE_FAILURE:
368 print_after_parse_failure = true;
373 pipe_name = poptGetArg(pc);
376 poptPrintUsage(pc, stderr, 0);
381 if (plugin != NULL) {
382 p = load_iface_from_plugin(plugin, pipe_name);
385 p = ndr_table_by_name(pipe_name);
391 status = GUID_from_string(pipe_name, &uuid);
393 if (NT_STATUS_IS_OK(status)) {
394 p = ndr_table_by_uuid(&uuid);
399 printf("Unknown pipe or UUID '%s'\n", pipe_name);
403 format = poptGetArg(pc);
404 type = poptGetArg(pc);
405 filename = poptGetArg(pc);
407 if (!format || !type) {
408 poptPrintUsage(pc, stderr, 0);
413 if (strcmp(type, "struct") == 0) {
414 flags = NDR_SCALARS|NDR_BUFFERS; /* neither NDR_IN nor NDR_OUT */
415 f = find_struct(p, format, &f_buffer);
417 f = find_function(p, format);
418 if (strcmp(type, "in") == 0 ||
419 strcmp(type, "request") == 0) {
421 } else if (strcmp(type, "out") == 0 ||
422 strcmp(type, "response") == 0) {
425 printf("Bad type value '%s'\n", type);
431 mem_ctx = talloc_init("ndrdump");
433 st = talloc_zero_size(mem_ctx, f->struct_size);
435 printf("Unable to allocate %d bytes for %s structure\n",
438 TALLOC_FREE(mem_ctx);
442 v_st = talloc_zero_size(mem_ctx, f->struct_size);
444 printf("Unable to allocate %d bytes for %s validation "
448 TALLOC_FREE(mem_ctx);
453 if (flags & NDR_IN) {
454 printf("Context file can only be used for \"out\" packages\n");
455 TALLOC_FREE(mem_ctx);
459 data = (uint8_t *)file_load(ctx_filename, &size, 0, mem_ctx);
461 perror(ctx_filename);
462 TALLOC_FREE(mem_ctx);
466 blob = data_blob_const(data, size);
468 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
469 if (ndr_pull == NULL) {
470 perror("ndr_pull_init_blob");
471 TALLOC_FREE(mem_ctx);
474 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
476 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
479 ndr_err = f->ndr_pull(ndr_pull, NDR_IN, st);
481 if (ndr_pull->offset > ndr_pull->relative_highest_offset) {
482 highest_ofs = ndr_pull->offset;
484 highest_ofs = ndr_pull->relative_highest_offset;
487 if (highest_ofs != ndr_pull->data_size) {
488 printf("WARNING! %d unread bytes while parsing context file\n", ndr_pull->data_size - highest_ofs);
491 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
492 printf("pull for context file returned %s\n",
493 ndr_map_error2string(ndr_err));
494 TALLOC_FREE(mem_ctx);
497 memcpy(v_st, st, f->struct_size);
500 if (filename && cmdline_input) {
501 printf("cannot combine --input with a filename\n");
502 TALLOC_FREE(mem_ctx);
504 } else if (cmdline_input) {
505 data = (const uint8_t *)cmdline_input;
506 size = strlen(cmdline_input);
507 } else if (filename) {
508 data = (uint8_t *)file_load(filename, &size, 0, mem_ctx);
510 data = (uint8_t *)stdin_load(mem_ctx, &size);
521 if (hex_input && base64_input) {
522 printf("cannot combine --hex-input with --base64-input\n");
523 TALLOC_FREE(mem_ctx);
526 } else if (hex_input) {
527 blob = hexdump_to_data_blob(mem_ctx, (const char *)data, size);
528 } else if (base64_input) {
529 /* Use talloc_strndup() to ensure null termination */
530 blob = base64_decode_data_blob(talloc_strndup(mem_ctx,
531 (const char *)data, size));
532 /* base64_decode_data_blob() allocates on NULL */
533 talloc_steal(mem_ctx, blob.data);
535 blob = data_blob_const(data, size);
538 if (data != NULL && blob.data == NULL) {
539 printf("failed to decode input data\n");
540 TALLOC_FREE(mem_ctx);
544 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
545 if (ndr_pull == NULL) {
546 perror("ndr_pull_init_blob");
547 TALLOC_FREE(mem_ctx);
550 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
552 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
555 ndr_print = talloc_zero(mem_ctx, struct ndr_print);
557 ndr_print->print = ndr_print_dummy;
559 ndr_print->print = ndr_print_printf_helper;
561 ndr_print->depth = 1;
563 ndr_err = ndr_pop_dcerpc_sec_verification_trailer(ndr_pull, mem_ctx, &sec_vt);
564 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
565 printf("ndr_pop_dcerpc_sec_verification_trailer returned %s\n",
566 ndr_map_error2string(ndr_err));
569 if (sec_vt != NULL && sec_vt->count.count > 0) {
570 printf("SEC_VT: consumed %d bytes\n",
571 (int)(blob.length - ndr_pull->data_size));
573 ndrdump_data(blob.data + ndr_pull->data_size,
574 blob.length - ndr_pull->data_size,
577 ndr_print_dcerpc_sec_verification_trailer(ndr_print, "SEC_VT", sec_vt);
581 if (flags & NDR_OUT) {
582 status = ndrdump_pull_and_print_pipes(format,
586 if (!NT_STATUS_IS_OK(status)) {
587 printf("pull and dump of OUT pipes FAILED: %s\n",
589 TALLOC_FREE(mem_ctx);
594 ndr_err = f->ndr_pull(ndr_pull, flags, st);
595 printf("pull returned %s\n",
596 ndr_map_error2string(ndr_err));
598 if (ndr_pull->offset > ndr_pull->relative_highest_offset) {
599 highest_ofs = ndr_pull->offset;
601 highest_ofs = ndr_pull->relative_highest_offset;
605 printf("%d bytes consumed\n", highest_ofs);
606 ndrdump_data(blob.data, blob.length, dumpdata);
609 if (!print_after_parse_failure && !NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
610 TALLOC_FREE(mem_ctx);
614 if (highest_ofs != ndr_pull->data_size) {
615 printf("WARNING! %d unread bytes\n", ndr_pull->data_size - highest_ofs);
616 ndrdump_data(ndr_pull->data+highest_ofs,
617 ndr_pull->data_size - highest_ofs,
621 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
622 printf("WARNING: pull of %s was incomplete, "
623 "therefore the parse below may SEGFAULT\n",
627 f->ndr_print(ndr_print, f->name, flags, st);
629 if (flags & NDR_IN) {
630 status = ndrdump_pull_and_print_pipes(format,
634 if (!NT_STATUS_IS_OK(status)) {
635 printf("pull and dump of IN pipes FAILED: %s\n",
641 /* Do not proceed to validate if we got an error */
642 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
643 printf("dump of failed-to-parse %s complete\n",
645 TALLOC_FREE(mem_ctx);
651 struct ndr_push *ndr_v_push;
652 struct ndr_pull *ndr_v_pull;
653 struct ndr_print *ndr_v_print;
654 uint32_t highest_v_ofs;
656 uint8_t byte_a, byte_b;
659 ndr_v_push = ndr_push_init_ctx(mem_ctx);
660 if (ndr_v_push == NULL) {
661 printf("No memory\n");
666 ndr_v_push->flags |= LIBNDR_FLAG_NDR64;
669 ndr_err = f->ndr_push(ndr_v_push, flags, st);
670 printf("push returned %s\n",
671 ndr_map_error2string(ndr_err));
672 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
673 printf("validate push FAILED\n");
674 TALLOC_FREE(mem_ctx);
678 v_blob = ndr_push_blob(ndr_v_push);
681 printf("%ld bytes generated (validate)\n", (long)v_blob.length);
682 ndrdump_data(v_blob.data, v_blob.length, dumpdata);
685 ndr_v_pull = ndr_pull_init_blob(&v_blob, mem_ctx);
686 if (ndr_v_pull == NULL) {
687 perror("ndr_pull_init_blob");
688 TALLOC_FREE(mem_ctx);
691 ndr_v_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
693 ndr_err = f->ndr_pull(ndr_v_pull, flags, v_st);
694 printf("pull returned %s\n",
695 ndr_map_error2string(ndr_err));
696 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
697 printf("validate pull FAILED\n");
698 TALLOC_FREE(mem_ctx);
702 if (ndr_v_pull->offset > ndr_v_pull->relative_highest_offset) {
703 highest_v_ofs = ndr_v_pull->offset;
705 highest_v_ofs = ndr_v_pull->relative_highest_offset;
708 if (highest_v_ofs != ndr_v_pull->data_size) {
709 printf("WARNING! %d unread bytes in validation\n",
710 ndr_v_pull->data_size - highest_v_ofs);
711 ndrdump_data(ndr_v_pull->data + highest_v_ofs,
712 ndr_v_pull->data_size - highest_v_ofs,
716 ndr_v_print = talloc_zero(mem_ctx, struct ndr_print);
717 ndr_v_print->print = ndr_print_debug_helper;
718 ndr_v_print->depth = 1;
719 f->ndr_print(ndr_v_print,
723 if (blob.length != v_blob.length) {
724 printf("WARNING! orig bytes:%llu validated pushed bytes:%llu\n",
725 (unsigned long long)blob.length, (unsigned long long)v_blob.length);
728 if (highest_ofs != highest_v_ofs) {
729 printf("WARNING! orig pulled bytes:%llu validated pulled bytes:%llu\n",
730 (unsigned long long)highest_ofs, (unsigned long long)highest_v_ofs);
736 for (i=0; i < blob.length; i++) {
737 byte_a = blob.data[i];
739 if (i == v_blob.length) {
745 byte_b = v_blob.data[i];
747 if (byte_a != byte_b) {
753 printf("WARNING! orig and validated differ at byte 0x%02X (%u)\n", i, i);
754 printf("WARNING! orig byte[0x%02X] = 0x%02X validated byte[0x%02X] = 0x%02X\n",
755 i, byte_a, i, byte_b);
760 TALLOC_FREE(mem_ctx);