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