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