lib/util Remove setup_logging_stdout()
[sfrench/samba-autobuild/.git] / 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 printf_cb(const char *buf, void *private_data)
131 {
132         printf("%s", buf);
133 }
134
135 static void ndrdump_data(uint8_t *d, uint32_t l, bool force)
136 {
137         dump_data_cb(d, l, !force, printf_cb, NULL);
138 }
139
140  int main(int argc, const char *argv[])
141 {
142         const struct ndr_interface_table *p = NULL;
143         const struct ndr_interface_call *f;
144         const char *pipe_name, *function, *inout, *filename;
145         uint8_t *data;
146         size_t size;
147         DATA_BLOB blob;
148         struct ndr_pull *ndr_pull;
149         struct ndr_print *ndr_print;
150         TALLOC_CTX *mem_ctx;
151         int flags;
152         poptContext pc;
153         NTSTATUS status;
154         enum ndr_err_code ndr_err;
155         void *st;
156         void *v_st;
157         const char *ctx_filename = NULL;
158         const char *plugin = NULL;
159         bool validate = false;
160         bool dumpdata = false;
161         bool assume_ndr64 = false;
162         int opt;
163         enum {OPT_CONTEXT_FILE=1000, OPT_VALIDATE, OPT_DUMP_DATA, OPT_LOAD_DSO, OPT_NDR64};
164         struct poptOption long_options[] = {
165                 POPT_AUTOHELP
166                 {"context-file", 'c', POPT_ARG_STRING, NULL, OPT_CONTEXT_FILE, "In-filename to parse first", "CTX-FILE" },
167                 {"validate", 0, POPT_ARG_NONE, NULL, OPT_VALIDATE, "try to validate the data", NULL },  
168                 {"dump-data", 0, POPT_ARG_NONE, NULL, OPT_DUMP_DATA, "dump the hex data", NULL },       
169                 {"load-dso", 'l', POPT_ARG_STRING, NULL, OPT_LOAD_DSO, "load from shared object file", NULL },
170                 {"ndr64", 0, POPT_ARG_NONE, NULL, OPT_NDR64, "Assume NDR64 data", NULL },
171                 POPT_COMMON_SAMBA
172                 POPT_COMMON_VERSION
173                 { NULL }
174         };
175
176         ndr_table_init();
177
178         /* Initialise samba stuff */
179         load_case_tables();
180
181         setlinebuf(stdout);
182
183         setup_logging("ndrdump", DEBUG_STDOUT);
184
185         pc = poptGetContext("ndrdump", argc, argv, long_options, 0);
186         
187         poptSetOtherOptionHelp(
188                 pc, "<pipe|uuid> <function> <inout> [<filename>]");
189
190         while ((opt = poptGetNextOpt(pc)) != -1) {
191                 switch (opt) {
192                 case OPT_CONTEXT_FILE:
193                         ctx_filename = poptGetOptArg(pc);
194                         break;
195                 case OPT_VALIDATE:
196                         validate = true;
197                         break;
198                 case OPT_DUMP_DATA:
199                         dumpdata = true;
200                         break;
201                 case OPT_LOAD_DSO:
202                         plugin = poptGetOptArg(pc);
203                         break;
204                 case OPT_NDR64:
205                         assume_ndr64 = true;
206                         break;
207                 }
208         }
209
210         pipe_name = poptGetArg(pc);
211
212         if (!pipe_name) {
213                 poptPrintUsage(pc, stderr, 0);
214                 show_pipes();
215                 exit(1);
216         }
217
218         if (plugin != NULL) {
219                 p = load_iface_from_plugin(plugin, pipe_name);
220         } 
221         if (!p) {
222                 p = ndr_table_by_name(pipe_name);
223         }
224
225         if (!p) {
226                 struct GUID uuid;
227
228                 status = GUID_from_string(pipe_name, &uuid);
229
230                 if (NT_STATUS_IS_OK(status)) {
231                         p = ndr_table_by_uuid(&uuid);
232                 }
233         }
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                 data = (uint8_t *)file_load(ctx_filename, &size, 0, mem_ctx);
284                 if (!data) {
285                         perror(ctx_filename);
286                         exit(1);
287                 }
288
289                 blob.data = data;
290                 blob.length = size;
291
292                 ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
293                 ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
294                 if (assume_ndr64) {
295                         ndr_pull->flags |= LIBNDR_FLAG_NDR64;
296                 }
297
298                 ndr_err = f->ndr_pull(ndr_pull, NDR_IN, st);
299
300                 if (ndr_pull->offset != ndr_pull->data_size) {
301                         printf("WARNING! %d unread bytes while parsing context file\n", ndr_pull->data_size - ndr_pull->offset);
302                 }
303
304                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
305                         status = ndr_map_error2ntstatus(ndr_err);
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                 data = (uint8_t *)file_load(filename, &size, 0, mem_ctx);
314         else
315                 data = (uint8_t *)stdin_load(mem_ctx, &size);
316
317         if (!data) {
318                 if (filename)
319                         perror(filename);
320                 else
321                         perror("stdin");
322                 exit(1);
323         }
324
325         blob.data = data;
326         blob.length = size;
327
328         ndr_pull = ndr_pull_init_blob(&blob, mem_ctx);
329         ndr_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
330         if (assume_ndr64) {
331                 ndr_pull->flags |= LIBNDR_FLAG_NDR64;
332         }
333
334         ndr_err = f->ndr_pull(ndr_pull, flags, st);
335         status = ndr_map_error2ntstatus(ndr_err);
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                 ndrdump_data(ndr_pull->data+ndr_pull->offset,
342                              ndr_pull->data_size - ndr_pull->offset,
343                              dumpdata);
344         }
345
346         if (dumpdata) {
347                 printf("%d bytes consumed\n", ndr_pull->offset);
348                 ndrdump_data(blob.data, blob.length, dumpdata);
349         }
350
351         ndr_print = talloc_zero(mem_ctx, struct ndr_print);
352         ndr_print->print = ndr_print_printf_helper;
353         ndr_print->depth = 1;
354         f->ndr_print(ndr_print, function, flags, st);
355
356         if (!NT_STATUS_IS_OK(status)) {
357                 printf("dump FAILED\n");
358                 exit(1);
359         }
360
361         if (validate) {
362                 DATA_BLOB v_blob;
363                 struct ndr_push *ndr_v_push;
364                 struct ndr_pull *ndr_v_pull;
365                 struct ndr_print *ndr_v_print;
366                 uint32_t i;
367                 uint8_t byte_a, byte_b;
368                 bool differ;
369
370                 ndr_v_push = ndr_push_init_ctx(mem_ctx);
371                 
372                 ndr_err = f->ndr_push(ndr_v_push, flags, st);
373                 status = ndr_map_error2ntstatus(ndr_err);
374                 printf("push returned %s\n", nt_errstr(status));
375                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
376                         printf("validate push FAILED\n");
377                         exit(1);
378                 }
379
380                 v_blob = ndr_push_blob(ndr_v_push);
381
382                 if (dumpdata) {
383                         printf("%ld bytes generated (validate)\n", (long)v_blob.length);
384                         ndrdump_data(v_blob.data, v_blob.length, dumpdata);
385                 }
386
387                 ndr_v_pull = ndr_pull_init_blob(&v_blob, mem_ctx);
388                 ndr_v_pull->flags |= LIBNDR_FLAG_REF_ALLOC;
389
390                 ndr_err = f->ndr_pull(ndr_v_pull, flags, v_st);
391                 status = ndr_map_error2ntstatus(ndr_err);
392                 printf("pull returned %s\n", nt_errstr(status));
393                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
394                         printf("validate pull FAILED\n");
395                         exit(1);
396                 }
397
398
399                 if (ndr_v_pull->offset != ndr_v_pull->data_size) {
400                         printf("WARNING! %d unread bytes in validation\n", ndr_v_pull->data_size - ndr_v_pull->offset);
401                         ndrdump_data(ndr_v_pull->data+ndr_v_pull->offset,
402                                      ndr_v_pull->data_size - ndr_v_pull->offset,
403                                      dumpdata);
404                 }
405
406                 ndr_v_print = talloc_zero(mem_ctx, struct ndr_print);
407                 ndr_v_print->print = ndr_print_debug_helper;
408                 ndr_v_print->depth = 1;
409                 f->ndr_print(ndr_v_print, function, flags, v_st);
410
411                 if (blob.length != v_blob.length) {
412                         printf("WARNING! orig bytes:%llu validated pushed bytes:%llu\n", 
413                                (unsigned long long)blob.length, (unsigned long long)v_blob.length);
414                 }
415
416                 if (ndr_pull->offset != ndr_v_pull->offset) {
417                         printf("WARNING! orig pulled bytes:%llu validated pulled bytes:%llu\n", 
418                                (unsigned long long)ndr_pull->offset, (unsigned long long)ndr_v_pull->offset);
419                 }
420
421                 differ = false;
422                 byte_a = 0x00;
423                 byte_b = 0x00;
424                 for (i=0; i < blob.length; i++) {
425                         byte_a = blob.data[i];
426
427                         if (i == v_blob.length) {
428                                 byte_b = 0x00;
429                                 differ = true;
430                                 break;
431                         }
432
433                         byte_b = v_blob.data[i];
434
435                         if (byte_a != byte_b) {
436                                 differ = true;
437                                 break;
438                         }
439                 }
440                 if (differ) {
441                         printf("WARNING! orig and validated differ at byte 0x%02X (%u)\n", i, i);
442                         printf("WARNING! orig byte[0x%02X] = 0x%02X validated byte[0x%02X] = 0x%02X\n",
443                                 i, byte_a, i, byte_b);
444                 }
445         }
446
447         printf("dump OK\n");
448
449         talloc_free(mem_ctx);
450
451         poptFreeContext(pc);
452         
453         return 0;
454 }