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