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"
30 static const struct ndr_interface_call *find_function(
31 const struct ndr_interface_table *p,
35 if (isdigit(function[0])) {
37 i = strtoul(function, &eptr, 0);
41 printf("Function number '%s' not found\n",
47 for (i=0;i<p->num_calls;i++) {
48 if (strcmp(p->calls[i].name, function) == 0) {
52 if (i == p->num_calls) {
53 printf("Function '%s' not found\n", function);
60 * Find a public structure on the pipe and return it as if it were
61 * a function (as the rest of ndrdump is based around functions)
63 static const struct ndr_interface_call *find_struct(
64 const struct ndr_interface_table *p,
65 const char *struct_name,
66 struct ndr_interface_call *out_buffer)
69 const struct ndr_interface_public_struct *public_struct = NULL;
70 if (isdigit(struct_name[0])) {
72 i = strtoul(struct_name, &eptr, 0);
73 if (i >= p->num_public_structs
76 printf("Public structure number '%s' not found\n",
80 public_struct = &p->public_structs[i];
82 for (i=0;i<p->num_public_structs;i++) {
83 if (strcmp(p->public_structs[i].name, struct_name) == 0) {
87 if (i == p->num_public_structs) {
88 printf("Public structure '%s' not found\n", struct_name);
91 public_struct = &p->public_structs[i];
93 *out_buffer = (struct ndr_interface_call) {
94 .name = public_struct->name,
95 .struct_size = public_struct->struct_size,
96 .ndr_pull = public_struct->ndr_pull,
97 .ndr_push = public_struct->ndr_push,
98 .ndr_print = public_struct->ndr_print
103 _NORETURN_ static void show_pipes(void)
105 const struct ndr_interface_list *l;
106 printf("\nYou must specify a pipe\n");
107 printf("known pipes are:\n");
108 for (l=ndr_table_list();l;l=l->next) {
109 if(l->table->helpstring) {
110 printf("\t%s - %s\n", l->table->name, l->table->helpstring);
112 printf("\t%s\n", l->table->name);
118 _NORETURN_ static void show_functions(const struct ndr_interface_table *p)
121 printf("\nYou must specify a function\n");
122 printf("known functions on '%s' are:\n", p->name);
123 for (i=0;i<p->num_calls;i++) {
124 printf("\t0x%02x (%2d) %s\n", i, i, p->calls[i].name);
126 printf("known public structures on '%s' are:\n", p->name);
127 for (i=0;i<p->num_public_structs;i++) {
128 printf("\t%s\n", p->public_structs[i].name);
133 static char *stdin_load(TALLOC_CTX *mem_ctx, size_t *size)
135 int num_read, total_len = 0;
139 while((num_read = read(STDIN_FILENO, buf, 255)) > 0) {
142 result = talloc_realloc(
143 mem_ctx, result, char, total_len + num_read);
145 result = talloc_array(mem_ctx, char, num_read);
148 memcpy(result + total_len, buf, num_read);
150 total_len += num_read;
159 static const struct ndr_interface_table *load_iface_from_plugin(const char *plugin, const char *pipe_name)
161 const struct ndr_interface_table *p;
165 handle = dlopen(plugin, RTLD_NOW);
166 if (handle == NULL) {
167 printf("%s: Unable to open: %s\n", plugin, dlerror());
171 symbol = talloc_asprintf(NULL, "ndr_table_%s", pipe_name);
172 p = (const struct ndr_interface_table *)dlsym(handle, symbol);
175 printf("%s: Unable to find DCE/RPC interface table for '%s': %s\n", plugin, pipe_name, dlerror());
186 static void ndrdump_data(uint8_t *d, uint32_t l, bool force)
188 dump_data_file(d, l, !force, stdout);
191 static NTSTATUS ndrdump_pull_and_print_pipes(const char *function,
192 struct ndr_pull *ndr_pull,
193 struct ndr_print *ndr_print,
194 const struct ndr_interface_call_pipes *pipes)
196 enum ndr_err_code ndr_err;
199 for (i=0; i < pipes->num_pipes; i++) {
207 c = talloc_zero_size(ndr_pull, pipes->pipes[i].chunk_struct_size);
208 talloc_set_name(c, "struct %s", pipes->pipes[i].name);
210 * Note: the first struct member is always
213 count = (uint32_t *)c;
215 n = talloc_asprintf(c, "%s: %s[%llu]",
216 function, pipes->pipes[i].name,
217 (unsigned long long)idx);
219 saved_mem_ctx = ndr_pull->current_mem_ctx;
220 ndr_pull->current_mem_ctx = c;
221 ndr_err = pipes->pipes[i].ndr_pull(ndr_pull, NDR_SCALARS, c);
222 ndr_pull->current_mem_ctx = saved_mem_ctx;
224 printf("pull returned %s\n",
225 ndr_map_error2string(ndr_err));
226 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
228 return ndr_map_error2ntstatus(ndr_err);
230 pipes->pipes[i].ndr_print(ndr_print, n, c);
243 static void ndr_print_dummy(struct ndr_print *ndr, const char *format, ...)
245 /* This is here so that you can turn ndr printing off for the purposes
246 of benchmarking ndr parsing. */
249 int main(int argc, const char *argv[])
251 const struct ndr_interface_table *p = NULL;
252 const struct ndr_interface_call *f;
253 struct ndr_interface_call f_buffer;
254 const char *pipe_name = NULL;
255 const char *filename = NULL;
260 * struct: a public structure
262 const char *type = NULL;
264 * Format is either the name of the decoding function or the
265 * name of a public structure
267 const char *format = NULL;
271 struct ndr_pull *ndr_pull;
272 struct ndr_print *ndr_print;
277 enum ndr_err_code ndr_err;
280 const char *ctx_filename = NULL;
281 const char *plugin = NULL;
282 bool validate = false;
283 bool dumpdata = false;
284 bool assume_ndr64 = false;
286 bool hex_input = false;
287 bool stop_on_parse_failure = false;
290 OPT_CONTEXT_FILE=1000,
297 OPT_STOP_ON_PARSE_FAILURE,
299 struct poptOption long_options[] = {
301 {"context-file", 'c', POPT_ARG_STRING, NULL, OPT_CONTEXT_FILE, "In-filename to parse first", "CTX-FILE" },
302 {"validate", 0, POPT_ARG_NONE, NULL, OPT_VALIDATE, "try to validate the data", NULL },
303 {"dump-data", 0, POPT_ARG_NONE, NULL, OPT_DUMP_DATA, "dump the hex data", NULL },
304 {"load-dso", 'l', POPT_ARG_STRING, NULL, OPT_LOAD_DSO, "load from shared object file", NULL },
305 {"ndr64", 0, POPT_ARG_NONE, NULL, OPT_NDR64, "Assume NDR64 data", NULL },
306 {"quiet", 0, POPT_ARG_NONE, NULL, OPT_QUIET, "Don't actually dump anything", NULL },
307 {"hex-input", 0, POPT_ARG_NONE, NULL, OPT_HEX_INPUT, "Read the input file in as a hex dump", NULL },
308 {"stop-on-parse-failure", 0, POPT_ARG_NONE, NULL, OPT_STOP_ON_PARSE_FAILURE,
309 "Do not try to print structures that fail to parse.", NULL },
314 uint32_t highest_ofs;
315 struct dcerpc_sec_verification_trailer *sec_vt = NULL;
319 /* Initialise samba stuff */
324 setup_logging("ndrdump", DEBUG_STDOUT);
326 pc = poptGetContext("ndrdump", argc, argv, long_options, 0);
328 poptSetOtherOptionHelp(
329 pc, "<pipe|uuid> <format> <in|out|struct> [<filename>]");
331 while ((opt = poptGetNextOpt(pc)) != -1) {
333 case OPT_CONTEXT_FILE:
334 ctx_filename = poptGetOptArg(pc);
343 plugin = poptGetOptArg(pc);
354 case OPT_STOP_ON_PARSE_FAILURE:
355 stop_on_parse_failure = true;
360 pipe_name = poptGetArg(pc);
363 poptPrintUsage(pc, stderr, 0);
368 if (plugin != NULL) {
369 p = load_iface_from_plugin(plugin, pipe_name);
372 p = ndr_table_by_name(pipe_name);
378 status = GUID_from_string(pipe_name, &uuid);
380 if (NT_STATUS_IS_OK(status)) {
381 p = ndr_table_by_uuid(&uuid);
386 printf("Unknown pipe or UUID '%s'\n", pipe_name);
390 format = poptGetArg(pc);
391 type = poptGetArg(pc);
392 filename = poptGetArg(pc);
394 if (!format || !type) {
395 poptPrintUsage(pc, stderr, 0);
400 if (strcmp(type, "struct") == 0) {
401 flags = NDR_SCALARS|NDR_BUFFERS; /* neither NDR_IN nor NDR_OUT */
402 f = find_struct(p, format, &f_buffer);
404 f = find_function(p, format);
405 if (strcmp(type, "in") == 0 ||
406 strcmp(type, "request") == 0) {
408 } else if (strcmp(type, "out") == 0 ||
409 strcmp(type, "response") == 0) {
412 printf("Bad type value '%s'\n", type);
418 mem_ctx = talloc_init("ndrdump");
420 st = talloc_zero_size(mem_ctx, f->struct_size);
422 printf("Unable to allocate %d bytes\n", (int)f->struct_size);
426 v_st = talloc_zero_size(mem_ctx, f->struct_size);
428 printf("Unable to allocate %d bytes\n", (int)f->struct_size);
433 if (flags & NDR_IN) {
434 printf("Context file can only be used for \"out\" packages\n");
438 data = (uint8_t *)file_load(ctx_filename, &size, 0, mem_ctx);
440 perror(ctx_filename);
447 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
448 if (ndr_pull == NULL) {
449 perror("ndr_pull_init_blob");
452 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
454 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
457 ndr_err = f->ndr_pull(ndr_pull, NDR_IN, st);
459 if (ndr_pull->offset > ndr_pull->relative_highest_offset) {
460 highest_ofs = ndr_pull->offset;
462 highest_ofs = ndr_pull->relative_highest_offset;
465 if (highest_ofs != ndr_pull->data_size) {
466 printf("WARNING! %d unread bytes while parsing context file\n", ndr_pull->data_size - highest_ofs);
469 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
470 printf("pull for context file returned %s\n",
471 ndr_map_error2string(ndr_err));
474 memcpy(v_st, st, f->struct_size);
478 data = (uint8_t *)file_load(filename, &size, 0, mem_ctx);
480 data = (uint8_t *)stdin_load(mem_ctx, &size);
491 blob = hexdump_to_data_blob(mem_ctx, (char *)data, size);
497 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
498 if (ndr_pull == NULL) {
499 perror("ndr_pull_init_blob");
502 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
504 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
507 ndr_print = talloc_zero(mem_ctx, struct ndr_print);
509 ndr_print->print = ndr_print_dummy;
511 ndr_print->print = ndr_print_printf_helper;
513 ndr_print->depth = 1;
515 ndr_err = ndr_pop_dcerpc_sec_verification_trailer(ndr_pull, mem_ctx, &sec_vt);
516 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
517 printf("ndr_pop_dcerpc_sec_verification_trailer returned %s\n",
518 ndr_map_error2string(ndr_err));
521 if (sec_vt != NULL && sec_vt->count.count > 0) {
522 printf("SEC_VT: consumed %d bytes\n",
523 (int)(blob.length - ndr_pull->data_size));
525 ndrdump_data(blob.data + ndr_pull->data_size,
526 blob.length - ndr_pull->data_size,
529 ndr_print_dcerpc_sec_verification_trailer(ndr_print, "SEC_VT", sec_vt);
533 if (flags & NDR_OUT) {
534 status = ndrdump_pull_and_print_pipes(format,
538 if (!NT_STATUS_IS_OK(status)) {
539 printf("dump FAILED\n");
544 ndr_err = f->ndr_pull(ndr_pull, flags, st);
545 printf("pull returned %s\n",
546 ndr_map_error2string(ndr_err));
548 if (stop_on_parse_failure && !NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
549 printf("not printing because --stop-on-parse-failure\n");
553 if (ndr_pull->offset > ndr_pull->relative_highest_offset) {
554 highest_ofs = ndr_pull->offset;
556 highest_ofs = ndr_pull->relative_highest_offset;
559 if (highest_ofs != ndr_pull->data_size) {
560 printf("WARNING! %d unread bytes\n", ndr_pull->data_size - highest_ofs);
561 ndrdump_data(ndr_pull->data+highest_ofs,
562 ndr_pull->data_size - highest_ofs,
567 printf("%d bytes consumed\n", highest_ofs);
568 ndrdump_data(blob.data, blob.length, dumpdata);
571 f->ndr_print(ndr_print, format, flags, st);
573 if (flags & NDR_IN) {
574 status = ndrdump_pull_and_print_pipes(format,
578 if (!NT_STATUS_IS_OK(status)) {
579 printf("dump FAILED\n");
586 struct ndr_push *ndr_v_push;
587 struct ndr_pull *ndr_v_pull;
588 struct ndr_print *ndr_v_print;
589 uint32_t highest_v_ofs;
591 uint8_t byte_a, byte_b;
594 ndr_v_push = ndr_push_init_ctx(mem_ctx);
595 if (ndr_v_push == NULL) {
596 printf("No memory\n");
601 ndr_v_push->flags |= LIBNDR_FLAG_NDR64;
604 ndr_err = f->ndr_push(ndr_v_push, flags, st);
605 printf("push returned %s\n",
606 ndr_map_error2string(ndr_err));
607 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
608 printf("validate push FAILED\n");
612 v_blob = ndr_push_blob(ndr_v_push);
615 printf("%ld bytes generated (validate)\n", (long)v_blob.length);
616 ndrdump_data(v_blob.data, v_blob.length, dumpdata);
619 ndr_v_pull = ndr_pull_init_blob(&v_blob, mem_ctx);
620 if (ndr_v_pull == NULL) {
621 perror("ndr_pull_init_blob");
624 ndr_v_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
626 ndr_err = f->ndr_pull(ndr_v_pull, flags, v_st);
627 printf("pull returned %s\n",
628 ndr_map_error2string(ndr_err));
629 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
630 printf("validate pull FAILED\n");
634 if (ndr_v_pull->offset > ndr_v_pull->relative_highest_offset) {
635 highest_v_ofs = ndr_v_pull->offset;
637 highest_v_ofs = ndr_v_pull->relative_highest_offset;
640 if (highest_v_ofs != ndr_v_pull->data_size) {
641 printf("WARNING! %d unread bytes in validation\n",
642 ndr_v_pull->data_size - highest_v_ofs);
643 ndrdump_data(ndr_v_pull->data + highest_v_ofs,
644 ndr_v_pull->data_size - highest_v_ofs,
648 ndr_v_print = talloc_zero(mem_ctx, struct ndr_print);
649 ndr_v_print->print = ndr_print_debug_helper;
650 ndr_v_print->depth = 1;
651 f->ndr_print(ndr_v_print,
655 if (blob.length != v_blob.length) {
656 printf("WARNING! orig bytes:%llu validated pushed bytes:%llu\n",
657 (unsigned long long)blob.length, (unsigned long long)v_blob.length);
660 if (highest_ofs != highest_v_ofs) {
661 printf("WARNING! orig pulled bytes:%llu validated pulled bytes:%llu\n",
662 (unsigned long long)highest_ofs, (unsigned long long)highest_v_ofs);
668 for (i=0; i < blob.length; i++) {
669 byte_a = blob.data[i];
671 if (i == v_blob.length) {
677 byte_b = v_blob.data[i];
679 if (byte_a != byte_b) {
685 printf("WARNING! orig and validated differ at byte 0x%02X (%u)\n", i, i);
686 printf("WARNING! orig byte[0x%02X] = 0x%02X validated byte[0x%02X] = 0x%02X\n",
687 i, byte_a, i, byte_b);
692 talloc_free(mem_ctx);