librpc/tools/ndrdump.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB torture tester
   4    Copyright (C) Andrew Tridgell 2003
   5    Copyright (C) Jelmer Vernooij 2006
   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 "system/filesys.h"
  23 #include "system/locale.h"
  24 #include "librpc/ndr/libndr.h"
  25 #include "librpc/ndr/ndr_table.h"
  26 #include "lib/cmdline/popt_common.h"
  27 #include "param/param.h"
  28
  29 static const struct ndr_interface_call *find_function(
  30         const struct ndr_interface_table *p,
  31         const char *function)
  32 {
  33         int i;
  34         if (isdigit(function[0])) {
  35                 i = strtol(function, NULL, 0);
  36                 return &p->calls[i];
  37         }
  38         for (i=0;i<p->num_calls;i++) {
  39                 if (strcmp(p->calls[i].name, function) == 0) {
  40                         break;
  41                 }
  42         }
  43         if (i == p->num_calls) {
  44                 printf("Function '%s' not found\n", function);
  45                 exit(1);
  46         }
  47         return &p->calls[i];
  48 }
  49
  50 _NORETURN_ static void show_pipes(void)
  51 {
  52         const struct ndr_interface_list *l;
  53         printf("\nYou must specify a pipe\n");
  54         printf("known pipes are:\n");
  55         for (l=ndr_table_list();l;l=l->next) {
  56                 if(l->table->helpstring) {
  57                         printf("\t%s - %s\n", l->table->name, l->table->helpstring);
  58                 } else {
  59                         printf("\t%s\n", l->table->name);
  60                 }
  61         }
  62         exit(1);
  63 }
  64
  65 _NORETURN_ static void show_functions(const struct ndr_interface_table *p)
  66 {
  67         int i;
  68         printf("\nYou must specify a function\n");
  69         printf("known functions on '%s' are:\n", p->name);
  70         for (i=0;i<p->num_calls;i++) {
  71                 printf("\t0x%02x (%2d) %s\n", i, i, p->calls[i].name);
  72         }
  73         exit(1);
  74 }
  75
  76 static char *stdin_load(TALLOC_CTX *mem_ctx, size_t *size)
  77 {
  78         int num_read, total_len = 0;
  79         char buf[255];
  80         char *result = NULL;
  81
  82         while((num_read = read(STDIN_FILENO, buf, 255)) > 0) {
  83
  84                 if (result) {
  85                         result = talloc_realloc(
  86                                 mem_ctx, result, char, total_len + num_read);
  87                 } else {
  88                         result = talloc_array(mem_ctx, char, num_read);
  89                 }
  90
  91                 memcpy(result + total_len, buf, num_read);
  92
  93                 total_len += num_read;
  94         }
  95
  96         if (size)
  97                 *size = total_len;
  98
  99         return result;
 100 }
 101
 102 static const struct ndr_interface_table *load_iface_from_plugin(const char *plugin, const char *pipe_name)
 103 {
 104         const struct ndr_interface_table *p;
 105         void *handle;
 106         char *symbol;
 107
 108         handle = dlopen(plugin, RTLD_NOW);
 109         if (handle == NULL) {
 110                 printf("%s: Unable to open: %s\n", plugin, dlerror());
 111                 return NULL;
 112         }
 113
 114         symbol = talloc_asprintf(NULL, "ndr_table_%s", pipe_name);
 115         p = (const struct ndr_interface_table *)dlsym(handle, symbol);
 116
 117         if (!p) {
 118                 printf("%s: Unable to find DCE/RPC interface table for '%s': %s\n", plugin, pipe_name, dlerror());
 119                 talloc_free(symbol);
 120                 return NULL;
 121         }
 122
 123         talloc_free(symbol);
 124
 125         return p;
 126 }
 127
 128 static void ndrdump_data(uint8_t *d, uint32_t l, bool force)
 129 {
 130         dump_data_file(d, l, !force, stdout);
 131 }
 132
 133 static NTSTATUS ndrdump_pull_and_print_pipes(const char *function,
 134                                 struct ndr_pull *ndr_pull,
 135                                 struct ndr_print *ndr_print,
 136                                 const struct ndr_interface_call_pipes *pipes)
 137 {
 138         NTSTATUS status;
 139         enum ndr_err_code ndr_err;
 140         uint32_t i;
 141
 142         for (i=0; i < pipes->num_pipes; i++) {
 143                 uint64_t idx = 0;
 144                 while (true) {
 145                         uint32_t *count;
 146                         void *c;
 147                         char *n;
 148
 149                         c = talloc_zero_size(ndr_pull, pipes->pipes[i].chunk_struct_size);
 150                         talloc_set_name(c, "struct %s", pipes->pipes[i].name);
 151                         /*
 152                          * Note: the first struct member is always
 153                          * 'uint32_t count;'
 154                          */
 155                         count = (uint32_t *)c;
 156
 157                         n = talloc_asprintf(c, "%s: %s[%llu]",
 158                                         function, pipes->pipes[i].name,
 159                                         (unsigned long long)idx);
 160
 161                         ndr_err = pipes->pipes[i].ndr_pull(ndr_pull, NDR_SCALARS, c);
 162                         status = ndr_map_error2ntstatus(ndr_err);
 163
 164                         printf("pull returned %s\n", nt_errstr(status));
 165                         if (!NT_STATUS_IS_OK(status)) {
 166                                 return status;
 167                         }
 168                         pipes->pipes[i].ndr_print(ndr_print, n, c);
 169
 170                         if (*count == 0) {
 171                                 break;
 172                         }
 173                         idx++;
 174                 }
 175         }
 176
 177         return NT_STATUS_OK;
 178 }
 179
 180  int main(int argc, const char *argv[])
 181 {
 182         const struct ndr_interface_table *p = NULL;
 183         const struct ndr_interface_call *f;
 184         const char *pipe_name, *function, *inout, *filename;
 185         uint8_t *data;
 186         size_t size;
 187         DATA_BLOB blob;
 188         struct ndr_pull *ndr_pull;
 189         struct ndr_print *ndr_print;
 190         TALLOC_CTX *mem_ctx;
 191         int flags;
 192         poptContext pc;
 193         NTSTATUS status;
 194         enum ndr_err_code ndr_err;
 195         void *st;
 196         void *v_st;
 197         const char *ctx_filename = NULL;
 198         const char *plugin = NULL;
 199         bool validate = false;
 200         bool dumpdata = false;
 201         bool assume_ndr64 = false;
 202         int opt;
 203         enum {OPT_CONTEXT_FILE=1000, OPT_VALIDATE, OPT_DUMP_DATA, OPT_LOAD_DSO, OPT_NDR64};
 204         struct poptOption long_options[] = {
 205                 POPT_AUTOHELP
 206                 {"context-file", 'c', POPT_ARG_STRING, NULL, OPT_CONTEXT_FILE, "In-filename to parse first", "CTX-FILE" },
 207                 {"validate", 0, POPT_ARG_NONE, NULL, OPT_VALIDATE, "try to validate the data", NULL },
 208                 {"dump-data", 0, POPT_ARG_NONE, NULL, OPT_DUMP_DATA, "dump the hex data", NULL },
 209                 {"load-dso", 'l', POPT_ARG_STRING, NULL, OPT_LOAD_DSO, "load from shared object file", NULL },
 210                 {"ndr64", 0, POPT_ARG_NONE, NULL, OPT_NDR64, "Assume NDR64 data", NULL },
 211                 POPT_COMMON_SAMBA
 212                 POPT_COMMON_VERSION
 213                 { NULL }
 214         };
 215         const struct ndr_interface_call_pipes *in_pipes = NULL;
 216         const struct ndr_interface_call_pipes *out_pipes = NULL;
 217
 218         ndr_table_init();
 219
 220         /* Initialise samba stuff */
 221         load_case_tables();
 222
 223         setlinebuf(stdout);
 224
 225         setup_logging("ndrdump", DEBUG_STDOUT);
 226
 227         pc = poptGetContext("ndrdump", argc, argv, long_options, 0);
 228
 229         poptSetOtherOptionHelp(
 230                 pc, "<pipe|uuid> <function> <inout> [<filename>]");
 231
 232         while ((opt = poptGetNextOpt(pc)) != -1) {
 233                 switch (opt) {
 234                 case OPT_CONTEXT_FILE:
 235                         ctx_filename = poptGetOptArg(pc);
 236                         break;
 237                 case OPT_VALIDATE:
 238                         validate = true;
 239                         break;
 240                 case OPT_DUMP_DATA:
 241                         dumpdata = true;
 242                         break;
 243                 case OPT_LOAD_DSO:
 244                         plugin = poptGetOptArg(pc);
 245                         break;
 246                 case OPT_NDR64:
 247                         assume_ndr64 = true;
 248                         break;
 249                 }
 250         }
 251
 252         pipe_name = poptGetArg(pc);
 253
 254         if (!pipe_name) {
 255                 poptPrintUsage(pc, stderr, 0);
 256                 show_pipes();
 257                 exit(1);
 258         }
 259
 260         if (plugin != NULL) {
 261                 p = load_iface_from_plugin(plugin, pipe_name);
 262         }
 263         if (!p) {
 264                 p = ndr_table_by_name(pipe_name);
 265         }
 266
 267         if (!p) {
 268                 struct GUID uuid;
 269
 270                 status = GUID_from_string(pipe_name, &uuid);
 271
 272                 if (NT_STATUS_IS_OK(status)) {
 273                         p = ndr_table_by_uuid(&uuid);
 274                 }
 275         }
 276
 277         if (!p) {
 278                 printf("Unknown pipe or UUID '%s'\n", pipe_name);
 279                 exit(1);
 280         }
 281
 282         function = poptGetArg(pc);
 283         inout = poptGetArg(pc);
 284         filename = poptGetArg(pc);
 285
 286         if (!function || !inout) {
 287                 poptPrintUsage(pc, stderr, 0);
 288                 show_functions(p);
 289                 exit(1);
 290         }
 291
 292         f = find_function(p, function);
 293
 294         if (strcmp(inout, "in") == 0 ||
 295             strcmp(inout, "request") == 0) {
 296                 flags = NDR_IN;
 297                 in_pipes = &f->in_pipes;
 298         } else if (strcmp(inout, "out") == 0 ||
 299                    strcmp(inout, "response") == 0) {
 300                 flags = NDR_OUT;
 301                 out_pipes = &f->out_pipes;
 302         } else {
 303                 printf("Bad inout value '%s'\n", inout);
 304                 exit(1);
 305         }
 306
 307         mem_ctx = talloc_init("ndrdump");
 308
 309         st = talloc_zero_size(mem_ctx, f->struct_size);
 310         if (!st) {
 311                 printf("Unable to allocate %d bytes\n", (int)f->struct_size);
 312                 exit(1);
 313         }
 314
 315         v_st = talloc_zero_size(mem_ctx, f->struct_size);
 316         if (!v_st) {
 317                 printf("Unable to allocate %d bytes\n", (int)f->struct_size);
 318                 exit(1);
 319         }
 320
 321         if (ctx_filename) {
 322                 if (flags == NDR_IN) {
 323                         printf("Context file can only be used for \"out\" packages\n");
 324                         exit(1);
 325                 }
 326
 327                 data = (uint8_t *)file_load(ctx_filename, &size, 0, mem_ctx);
 328                 if (!data) {
 329                         perror(ctx_filename);
 330                         exit(1);
 331                 }
 332
 333                 blob.data = data;
 334                 blob.length = size;
 335
 336                 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
 337                 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
 338                 if (assume_ndr64) {
 339                         ndr_pull->flags |= LIBNDR_FLAG_NDR64;
 340                 }
 341
 342                 ndr_err = f->ndr_pull(ndr_pull, NDR_IN, st);
 343
 344                 if (ndr_pull->offset != ndr_pull->data_size) {
 345                         printf("WARNING! %d unread bytes while parsing context file\n", ndr_pull->data_size - ndr_pull->offset);
 346                 }
 347
 348                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 349                         status = ndr_map_error2ntstatus(ndr_err);
 350                         printf("pull for context file returned %s\n", nt_errstr(status));
 351                         exit(1);
 352                 }
 353                 memcpy(v_st, st, f->struct_size);
 354         }
 355
 356         if (filename)
 357                 data = (uint8_t *)file_load(filename, &size, 0, mem_ctx);
 358         else
 359                 data = (uint8_t *)stdin_load(mem_ctx, &size);
 360
 361         if (!data) {
 362                 if (filename)
 363                         perror(filename);
 364                 else
 365                         perror("stdin");
 366                 exit(1);
 367         }
 368
 369         blob.data = data;
 370         blob.length = size;
 371
 372         ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
 373         ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
 374         if (assume_ndr64) {
 375                 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
 376         }
 377
 378         ndr_print = talloc_zero(mem_ctx, struct ndr_print);
 379         ndr_print->print = ndr_print_printf_helper;
 380         ndr_print->depth = 1;
 381
 382         if (out_pipes) {
 383                 status = ndrdump_pull_and_print_pipes(function, ndr_pull, ndr_print, out_pipes);
 384                 if (!NT_STATUS_IS_OK(status)) {
 385                         printf("dump FAILED\n");
 386                         exit(1);
 387                 }
 388         }
 389
 390         ndr_err = f->ndr_pull(ndr_pull, flags, st);
 391         status = ndr_map_error2ntstatus(ndr_err);
 392
 393         printf("pull returned %s\n", nt_errstr(status));
 394
 395         if (ndr_pull->offset != ndr_pull->data_size) {
 396                 printf("WARNING! %d unread bytes\n", ndr_pull->data_size - ndr_pull->offset);
 397                 ndrdump_data(ndr_pull->data+ndr_pull->offset,
 398                              ndr_pull->data_size - ndr_pull->offset,
 399                              dumpdata);
 400         }
 401
 402         if (dumpdata) {
 403                 printf("%d bytes consumed\n", ndr_pull->offset);
 404                 ndrdump_data(blob.data, blob.length, dumpdata);
 405         }
 406
 407         f->ndr_print(ndr_print, function, flags, st);
 408
 409         if (!NT_STATUS_IS_OK(status)) {
 410                 printf("dump FAILED\n");
 411                 exit(1);
 412         }
 413
 414         if (in_pipes) {
 415                 status = ndrdump_pull_and_print_pipes(function, ndr_pull, ndr_print, in_pipes);
 416                 if (!NT_STATUS_IS_OK(status)) {
 417                         printf("dump FAILED\n");
 418                         exit(1);
 419                 }
 420         }
 421
 422         if (validate) {
 423                 DATA_BLOB v_blob;
 424                 struct ndr_push *ndr_v_push;
 425                 struct ndr_pull *ndr_v_pull;
 426                 struct ndr_print *ndr_v_print;
 427                 uint32_t i;
 428                 uint8_t byte_a, byte_b;
 429                 bool differ;
 430
 431                 ndr_v_push = ndr_push_init_ctx(mem_ctx);
 432
 433                 ndr_err = f->ndr_push(ndr_v_push, flags, st);
 434                 status = ndr_map_error2ntstatus(ndr_err);
 435                 printf("push returned %s\n", nt_errstr(status));
 436                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 437                         printf("validate push FAILED\n");
 438                         exit(1);
 439                 }
 440
 441                 v_blob = ndr_push_blob(ndr_v_push);
 442
 443                 if (dumpdata) {
 444                         printf("%ld bytes generated (validate)\n", (long)v_blob.length);
 445                         ndrdump_data(v_blob.data, v_blob.length, dumpdata);
 446                 }
 447
 448                 ndr_v_pull = ndr_pull_init_blob(&v_blob, mem_ctx);
 449                 ndr_v_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
 450
 451                 ndr_err = f->ndr_pull(ndr_v_pull, flags, v_st);
 452                 status = ndr_map_error2ntstatus(ndr_err);
 453                 printf("pull returned %s\n", nt_errstr(status));
 454                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 455                         printf("validate pull FAILED\n");
 456                         exit(1);
 457                 }
 458
 459
 460                 if (ndr_v_pull->offset != ndr_v_pull->data_size) {
 461                         printf("WARNING! %d unread bytes in validation\n", ndr_v_pull->data_size - ndr_v_pull->offset);
 462                         ndrdump_data(ndr_v_pull->data+ndr_v_pull->offset,
 463                                      ndr_v_pull->data_size - ndr_v_pull->offset,
 464                                      dumpdata);
 465                 }
 466
 467                 ndr_v_print = talloc_zero(mem_ctx, struct ndr_print);
 468                 ndr_v_print->print = ndr_print_debug_helper;
 469                 ndr_v_print->depth = 1;
 470                 f->ndr_print(ndr_v_print, function, flags, v_st);
 471
 472                 if (blob.length != v_blob.length) {
 473                         printf("WARNING! orig bytes:%llu validated pushed bytes:%llu\n",
 474                                (unsigned long long)blob.length, (unsigned long long)v_blob.length);
 475                 }
 476
 477                 if (ndr_pull->offset != ndr_v_pull->offset) {
 478                         printf("WARNING! orig pulled bytes:%llu validated pulled bytes:%llu\n",
 479                                (unsigned long long)ndr_pull->offset, (unsigned long long)ndr_v_pull->offset);
 480                 }
 481
 482                 differ = false;
 483                 byte_a = 0x00;
 484                 byte_b = 0x00;
 485                 for (i=0; i < blob.length; i++) {
 486                         byte_a = blob.data[i];
 487
 488                         if (i == v_blob.length) {
 489                                 byte_b = 0x00;
 490                                 differ = true;
 491                                 break;
 492                         }
 493
 494                         byte_b = v_blob.data[i];
 495
 496                         if (byte_a != byte_b) {
 497                                 differ = true;
 498                                 break;
 499                         }
 500                 }
 501                 if (differ) {
 502                         printf("WARNING! orig and validated differ at byte 0x%02X (%u)\n", i, i);
 503                         printf("WARNING! orig byte[0x%02X] = 0x%02X validated byte[0x%02X] = 0x%02X\n",
 504                                 i, byte_a, i, byte_b);
 505                 }
 506         }
 507
 508         printf("dump OK\n");
 509
 510         talloc_free(mem_ctx);
 511
 512         poptFreeContext(pc);
 513
 514         return 0;
 515 }