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/cmdline.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 void ndrdump_data_diff(const uint8_t *d1, size_t l1,
193 const uint8_t *d2, size_t l2,
196 dump_data_file_diff(stdout, !force, d1, l1, d2, l2);
199 static NTSTATUS ndrdump_pull_and_print_pipes(const char *function,
200 struct ndr_pull *ndr_pull,
201 struct ndr_print *ndr_print,
202 const struct ndr_interface_call_pipes *pipes)
204 enum ndr_err_code ndr_err;
207 for (i=0; i < pipes->num_pipes; i++) {
215 c = talloc_zero_size(ndr_pull, pipes->pipes[i].chunk_struct_size);
216 talloc_set_name(c, "struct %s", pipes->pipes[i].name);
218 * Note: the first struct member is always
221 count = (uint32_t *)c;
223 n = talloc_asprintf(c, "%s: %s[%"PRIu64"]",
224 function, pipes->pipes[i].name,
227 saved_mem_ctx = ndr_pull->current_mem_ctx;
228 ndr_pull->current_mem_ctx = c;
229 ndr_err = pipes->pipes[i].ndr_pull(ndr_pull, NDR_SCALARS, c);
230 ndr_pull->current_mem_ctx = saved_mem_ctx;
232 printf("pull returned %s\n",
233 ndr_map_error2string(ndr_err));
234 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
236 return ndr_map_error2ntstatus(ndr_err);
238 pipes->pipes[i].ndr_print(ndr_print, n, c);
251 static void ndr_print_dummy(struct ndr_print *ndr, const char *format, ...)
253 /* This is here so that you can turn ndr printing off for the purposes
254 of benchmarking ndr parsing. */
257 int main(int argc, const char *argv[])
259 const struct ndr_interface_table *p = NULL;
260 const struct ndr_interface_call *f;
261 struct ndr_interface_call f_buffer;
262 const char *pipe_name = NULL;
263 const char *filename = NULL;
268 * struct: a public structure
270 const char *type = NULL;
272 * Format is either the name of the decoding function or the
273 * name of a public structure
275 const char *format = NULL;
276 const char *cmdline_input = NULL;
280 struct ndr_pull *ndr_pull;
281 struct ndr_print *ndr_print;
283 ndr_flags_type flags = 0;
286 enum ndr_err_code ndr_err;
289 const char *ctx_filename = NULL;
290 const char *plugin = NULL;
291 bool validate = false;
292 bool dumpdata = false;
293 bool assume_ndr64 = false;
295 bool hex_input = false;
296 bool base64_input = false;
297 bool print_after_parse_failure = false;
300 OPT_CONTEXT_FILE=1000,
309 OPT_PRINT_AFTER_PARSE_FAILURE,
311 struct poptOption long_options[] = {
313 {"context-file", 'c', POPT_ARG_STRING, NULL, OPT_CONTEXT_FILE, "In-filename to parse first", "CTX-FILE" },
314 {"validate", 0, POPT_ARG_NONE, NULL, OPT_VALIDATE, "try to validate the data", NULL },
315 {"dump-data", 0, POPT_ARG_NONE, NULL, OPT_DUMP_DATA, "dump the hex data", NULL },
316 {"load-dso", 0, POPT_ARG_STRING, NULL, OPT_LOAD_DSO, "load from shared object file", NULL },
317 {"ndr64", 0, POPT_ARG_NONE, NULL, OPT_NDR64, "Assume NDR64 data", NULL },
318 {"quiet", 0, POPT_ARG_NONE, NULL, OPT_QUIET, "Don't actually dump anything", NULL },
319 {"base64-input", 0, POPT_ARG_NONE, NULL, OPT_BASE64_INPUT, "Read the input file in as a base64 string", NULL },
320 {"hex-input", 0, POPT_ARG_NONE, NULL, OPT_HEX_INPUT, "Read the input file in as a hex dump", NULL },
321 {"input", 0, POPT_ARG_STRING, NULL, OPT_CMDLINE_INPUT, "Provide the input on the command line (use with --base64-input)", "INPUT" },
322 {"print-after-parse-failure", 0, POPT_ARG_NONE, NULL, OPT_PRINT_AFTER_PARSE_FAILURE,
323 "Try to print structures that fail to parse (used to develop parsers, segfaults are likely).", NULL },
328 uint32_t highest_ofs;
329 struct dcerpc_sec_verification_trailer *sec_vt = NULL;
334 /* Initialise samba stuff */
339 mem_ctx = talloc_init("ndrdump.c/main");
340 if (mem_ctx == NULL) {
344 ok = samba_cmdline_init(mem_ctx,
345 SAMBA_CMDLINE_CONFIG_CLIENT,
346 false /* require_smbconf */);
348 DBG_ERR("Failed to init cmdline parser!\n");
349 TALLOC_FREE(mem_ctx);
353 pc = samba_popt_get_context(getprogname(),
359 DBG_ERR("Failed to setup popt context!\n");
360 TALLOC_FREE(mem_ctx);
364 poptSetOtherOptionHelp(
365 pc, "<pipe|uuid> <format> <in|out|struct> [<filename>]");
367 while ((opt = poptGetNextOpt(pc)) != -1) {
369 case OPT_CONTEXT_FILE:
370 ctx_filename = poptGetOptArg(pc);
379 plugin = poptGetOptArg(pc);
387 case OPT_BASE64_INPUT:
393 case OPT_CMDLINE_INPUT:
394 cmdline_input = poptGetOptArg(pc);
396 case OPT_PRINT_AFTER_PARSE_FAILURE:
397 print_after_parse_failure = true;
402 pipe_name = poptGetArg(pc);
405 poptPrintUsage(pc, stderr, 0);
410 if (plugin != NULL) {
411 p = load_iface_from_plugin(plugin, pipe_name);
414 p = ndr_table_by_name(pipe_name);
420 status = GUID_from_string(pipe_name, &uuid);
422 if (NT_STATUS_IS_OK(status)) {
423 p = ndr_table_by_uuid(&uuid);
428 printf("Unknown pipe or UUID '%s'\n", pipe_name);
432 format = poptGetArg(pc);
433 type = poptGetArg(pc);
434 filename = poptGetArg(pc);
436 if (!format || !type) {
437 poptPrintUsage(pc, stderr, 0);
442 if (strcmp(type, "struct") == 0) {
443 flags = NDR_SCALARS|NDR_BUFFERS; /* neither NDR_IN nor NDR_OUT */
444 f = find_struct(p, format, &f_buffer);
446 f = find_function(p, format);
447 if (strcmp(type, "in") == 0 ||
448 strcmp(type, "request") == 0) {
450 } else if (strcmp(type, "out") == 0 ||
451 strcmp(type, "response") == 0) {
454 printf("Bad type value '%s'\n", type);
459 st = talloc_zero_size(mem_ctx, f->struct_size);
461 printf("Unable to allocate %zu bytes for %s structure\n",
464 TALLOC_FREE(mem_ctx);
468 v_st = talloc_zero_size(mem_ctx, f->struct_size);
470 printf("Unable to allocate %zu bytes for %s validation "
474 TALLOC_FREE(mem_ctx);
479 if (flags & NDR_IN) {
480 printf("Context file can only be used for \"out\" packages\n");
481 TALLOC_FREE(mem_ctx);
485 data = (uint8_t *)file_load(ctx_filename, &size, 0, mem_ctx);
487 perror(ctx_filename);
488 TALLOC_FREE(mem_ctx);
492 blob = data_blob_const(data, size);
494 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
495 if (ndr_pull == NULL) {
496 perror("ndr_pull_init_blob");
497 TALLOC_FREE(mem_ctx);
500 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
502 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
505 ndr_err = f->ndr_pull(ndr_pull, NDR_IN, st);
507 if (ndr_pull->offset > ndr_pull->relative_highest_offset) {
508 highest_ofs = ndr_pull->offset;
510 highest_ofs = ndr_pull->relative_highest_offset;
513 if (highest_ofs != ndr_pull->data_size) {
514 printf("WARNING! %"PRIu32" unread bytes while parsing context file\n", ndr_pull->data_size - highest_ofs);
517 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
518 printf("pull for context file returned %s\n",
519 ndr_map_error2string(ndr_err));
520 TALLOC_FREE(mem_ctx);
523 memcpy(v_st, st, f->struct_size);
526 if (filename && cmdline_input) {
527 printf("cannot combine --input with a filename\n");
528 TALLOC_FREE(mem_ctx);
530 } else if (cmdline_input) {
531 data = (const uint8_t *)cmdline_input;
532 size = strlen(cmdline_input);
533 } else if (filename) {
534 data = (uint8_t *)file_load(filename, &size, 0, mem_ctx);
536 data = (uint8_t *)stdin_load(mem_ctx, &size);
547 if (hex_input && base64_input) {
548 printf("cannot combine --hex-input with --base64-input\n");
549 TALLOC_FREE(mem_ctx);
552 } else if (hex_input && size >= 1 && data[0] != '[') {
553 blob = strhex_to_data_blob(mem_ctx, (const char *)data);
554 } else if (hex_input) {
555 blob = hexdump_to_data_blob(mem_ctx, (const char *)data, size);
556 } else if (base64_input) {
557 /* Use talloc_strndup() to ensure null termination */
558 blob = base64_decode_data_blob_talloc(
560 talloc_strndup(mem_ctx, (const char *)data, size));
562 blob = data_blob_const(data, size);
565 if (data != NULL && blob.data == NULL) {
566 printf("failed to decode input data\n");
567 TALLOC_FREE(mem_ctx);
571 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
572 if (ndr_pull == NULL) {
573 perror("ndr_pull_init_blob");
574 TALLOC_FREE(mem_ctx);
577 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
579 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
582 ndr_print = talloc_zero(mem_ctx, struct ndr_print);
584 ndr_print->print = ndr_print_dummy;
586 ndr_print->print = ndr_print_printf_helper;
588 ndr_print->depth = 1;
590 ndr_err = ndr_pop_dcerpc_sec_verification_trailer(ndr_pull, mem_ctx, &sec_vt);
591 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
592 printf("ndr_pop_dcerpc_sec_verification_trailer returned %s\n",
593 ndr_map_error2string(ndr_err));
596 if (sec_vt != NULL && sec_vt->count.count > 0) {
597 printf("SEC_VT: consumed %zu bytes\n",
598 blob.length - ndr_pull->data_size);
600 ndrdump_data(blob.data + ndr_pull->data_size,
601 blob.length - ndr_pull->data_size,
604 ndr_print_dcerpc_sec_verification_trailer(ndr_print, "SEC_VT", sec_vt);
608 if (flags & NDR_OUT) {
609 status = ndrdump_pull_and_print_pipes(format,
613 if (!NT_STATUS_IS_OK(status)) {
614 printf("pull and dump of OUT pipes FAILED: %s\n",
616 TALLOC_FREE(mem_ctx);
621 ndr_err = f->ndr_pull(ndr_pull, flags, st);
622 printf("pull returned %s\n",
623 ndr_map_error2string(ndr_err));
625 if (ndr_pull->offset > ndr_pull->relative_highest_offset) {
626 highest_ofs = ndr_pull->offset;
628 highest_ofs = ndr_pull->relative_highest_offset;
632 printf("%"PRIu32" bytes consumed\n", highest_ofs);
633 ndrdump_data(blob.data, blob.length, dumpdata);
636 if (!print_after_parse_failure && !NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
637 TALLOC_FREE(mem_ctx);
641 if (highest_ofs != ndr_pull->data_size) {
642 printf("WARNING! %"PRIu32" unread bytes\n", ndr_pull->data_size - highest_ofs);
643 ndrdump_data(ndr_pull->data+highest_ofs,
644 ndr_pull->data_size - highest_ofs,
648 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
649 printf("WARNING: pull of %s was incomplete, "
650 "therefore the parse below may SEGFAULT\n",
654 f->ndr_print(ndr_print, f->name, flags, st);
656 if (flags & NDR_IN) {
657 status = ndrdump_pull_and_print_pipes(format,
661 if (!NT_STATUS_IS_OK(status)) {
662 printf("pull and dump of IN pipes FAILED: %s\n",
668 /* Do not proceed to validate if we got an error */
669 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
670 printf("dump of failed-to-parse %s complete\n",
672 TALLOC_FREE(mem_ctx);
678 struct ndr_push *ndr_v_push;
679 struct ndr_pull *ndr_v_pull;
680 struct ndr_print *ndr_v_print;
681 uint32_t highest_v_ofs;
683 uint8_t byte_a, byte_b;
686 ndr_v_push = ndr_push_init_ctx(mem_ctx);
687 if (ndr_v_push == NULL) {
688 printf("No memory\n");
693 ndr_v_push->flags |= LIBNDR_FLAG_NDR64;
696 ndr_err = f->ndr_push(ndr_v_push, flags, st);
697 printf("push returned %s\n",
698 ndr_map_error2string(ndr_err));
699 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
700 printf("validate push FAILED\n");
701 TALLOC_FREE(mem_ctx);
705 v_blob = ndr_push_blob(ndr_v_push);
708 printf("%zu bytes generated (validate)\n", v_blob.length);
709 ndrdump_data(v_blob.data, v_blob.length, dumpdata);
712 ndr_v_pull = ndr_pull_init_blob(&v_blob, mem_ctx);
713 if (ndr_v_pull == NULL) {
714 perror("ndr_pull_init_blob");
715 TALLOC_FREE(mem_ctx);
718 ndr_v_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
720 ndr_err = f->ndr_pull(ndr_v_pull, flags, v_st);
721 printf("pull returned %s\n",
722 ndr_map_error2string(ndr_err));
723 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
724 printf("validate pull FAILED\n");
725 TALLOC_FREE(mem_ctx);
729 if (ndr_v_pull->offset > ndr_v_pull->relative_highest_offset) {
730 highest_v_ofs = ndr_v_pull->offset;
732 highest_v_ofs = ndr_v_pull->relative_highest_offset;
735 if (highest_v_ofs != ndr_v_pull->data_size) {
736 printf("WARNING! %"PRIu32" unread bytes in validation\n",
737 ndr_v_pull->data_size - highest_v_ofs);
738 ndrdump_data(ndr_v_pull->data + highest_v_ofs,
739 ndr_v_pull->data_size - highest_v_ofs,
743 ndr_v_print = talloc_zero(mem_ctx, struct ndr_print);
744 ndr_v_print->print = ndr_print_debug_helper;
745 ndr_v_print->depth = 1;
746 f->ndr_print(ndr_v_print,
750 if (blob.length != v_blob.length) {
751 printf("WARNING! orig bytes:%zu validated pushed bytes:%zu\n",
752 blob.length, v_blob.length);
755 if (highest_ofs != highest_v_ofs) {
756 printf("WARNING! orig pulled bytes:%"PRIu32" validated pulled bytes:%"PRIu32"\n",
757 highest_ofs, highest_v_ofs);
763 for (i=0; i < blob.length; i++) {
764 byte_a = blob.data[i];
766 if (i == v_blob.length) {
772 byte_b = v_blob.data[i];
774 if (byte_a != byte_b) {
780 printf("WARNING! orig and validated differ at byte 0x%02"PRIX32" (%"PRIu32")\n", i, i);
781 printf("WARNING! orig byte[0x%02"PRIX32"] = 0x%02"PRIX8" validated byte[0x%02"PRIX32"] = 0x%02"PRIX8"\n",
782 i, byte_a, i, byte_b);
783 ndrdump_data_diff(blob.data, blob.length,
784 v_blob.data, v_blob.length,
790 TALLOC_FREE(mem_ctx);