?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
libndr: add LIBNDR_FLAG_NO_RELATIVE_REVERSE so that relative reverse processing can...
[Samba.git] / librpc / ndr / ndr.c
blobc3759985e83e665d4cf06f1da2fb7d19a3093b04
1 /*
2 Unix SMB/CIFS implementation.
3
4 libndr interface
5
6 Copyright (C) Andrew Tridgell 2003
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22 /*
23 this provides the core routines for NDR parsing functions
24
25 see http://www.opengroup.org/onlinepubs/9629399/chap14.htm for details
26 of NDR encoding rules
27 */
28
29 #include "includes.h"
30 #include "librpc/ndr/libndr.h"
31 #include "../lib/util/dlinklist.h"
32 #if _SAMBA_BUILD_ == 4
33 #include "param/param.h"
34 #endif
35
36 #define NDR_BASE_MARSHALL_SIZE 1024
37
38 /* this guid indicates NDR encoding in a protocol tower */
39 const struct ndr_syntax_id ndr_transfer_syntax = {
40 { 0x8a885d04, 0x1ceb, 0x11c9, {0x9f, 0xe8}, {0x08,0x00,0x2b,0x10,0x48,0x60} },
41 2
42 };
43
44 const struct ndr_syntax_id ndr64_transfer_syntax = {
45 { 0x71710533, 0xbeba, 0x4937, {0x83, 0x19}, {0xb5,0xdb,0xef,0x9c,0xcc,0x36} },
46 1
47 };
48
49 /*
50 work out the number of bytes needed to align on a n byte boundary
51 */
52 _PUBLIC_ size_t ndr_align_size(uint32_t offset, size_t n)
53 {
54 if ((offset & (n-1)) == 0) return 0;
55 return n - (offset & (n-1));
56 }
57
58 /*
59 initialise a ndr parse structure from a data blob
60 */
61 _PUBLIC_ struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience)
62 {
63 struct ndr_pull *ndr;
64
65 ndr = talloc_zero(mem_ctx, struct ndr_pull);
66 if (!ndr) return NULL;
67 ndr->current_mem_ctx = mem_ctx;
68
69 ndr->data = blob->data;
70 ndr->data_size = blob->length;
71 ndr->iconv_convenience = talloc_reference(ndr, iconv_convenience);
72
73 return ndr;
74 }
75
76 /*
77 advance by 'size' bytes
78 */
79 _PUBLIC_ enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size)
80 {
81 ndr->offset += size;
82 if (ndr->offset > ndr->data_size) {
83 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
84 "ndr_pull_advance by %u failed",
85 size);
86 }
87 return NDR_ERR_SUCCESS;
88 }
89
90 /*
91 set the parse offset to 'ofs'
92 */
93 static enum ndr_err_code ndr_pull_set_offset(struct ndr_pull *ndr, uint32_t ofs)
94 {
95 ndr->offset = ofs;
96 if (ndr->offset > ndr->data_size) {
97 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
98 "ndr_pull_set_offset %u failed",
99 ofs);
100 }
101 return NDR_ERR_SUCCESS;
102 }
103
104 /* create a ndr_push structure, ready for some marshalling */
105 _PUBLIC_ struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience)
106 {
107 struct ndr_push *ndr;
108
109 ndr = talloc_zero(mem_ctx, struct ndr_push);
110 if (!ndr) {
111 return NULL;
112 }
113
114 ndr->flags = 0;
115 ndr->alloc_size = NDR_BASE_MARSHALL_SIZE;
116 ndr->data = talloc_array(ndr, uint8_t, ndr->alloc_size);
117 if (!ndr->data) {
118 return NULL;
119 }
120 ndr->iconv_convenience = talloc_reference(ndr, iconv_convenience);
121
122 return ndr;
123 }
124
125 /* return a DATA_BLOB structure for the current ndr_push marshalled data */
126 _PUBLIC_ DATA_BLOB ndr_push_blob(struct ndr_push *ndr)
127 {
128 DATA_BLOB blob;
129 blob = data_blob_const(ndr->data, ndr->offset);
130 if (ndr->alloc_size > ndr->offset) {
131 ndr->data[ndr->offset] = 0;
132 }
133 return blob;
134 }
135
136
137 /*
138 expand the available space in the buffer to ndr->offset + extra_size
139 */
140 _PUBLIC_ enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size)
141 {
142 uint32_t size = extra_size + ndr->offset;
143
144 if (size < ndr->offset) {
145 /* extra_size overflowed the offset */
146 return ndr_push_error(ndr, NDR_ERR_BUFSIZE, "Overflow in push_expand to %u",
147 size);
148 }
149
150 if (ndr->alloc_size > size) {
151 return NDR_ERR_SUCCESS;
152 }
153
154 ndr->alloc_size += NDR_BASE_MARSHALL_SIZE;
155 if (size+1 > ndr->alloc_size) {
156 ndr->alloc_size = size+1;
157 }
158 ndr->data = talloc_realloc(ndr, ndr->data, uint8_t, ndr->alloc_size);
159 if (!ndr->data) {
160 return ndr_push_error(ndr, NDR_ERR_ALLOC, "Failed to push_expand to %u",
161 ndr->alloc_size);
162 }
163
164 return NDR_ERR_SUCCESS;
165 }
166
167 _PUBLIC_ void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...)
168 {
169 va_list ap;
170 char *s = NULL;
171 int i, ret;
172
173 va_start(ap, format);
174 ret = vasprintf(&s, format, ap);
175 va_end(ap);
176
177 if (ret == -1) {
178 return;
179 }
180
181 for (i=0;i<ndr->depth;i++) {
182 DEBUGADD(1,(" "));
183 }
184
185 DEBUGADD(1,("%s\n", s));
186 free(s);
187 }
188
189 _PUBLIC_ void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...)
190 {
191 va_list ap;
192 int i;
193
194 for (i=0;i<ndr->depth;i++) {
195 ndr->private_data = talloc_asprintf_append_buffer(
196 (char *)ndr->private_data, " ");
197 }
198
199 va_start(ap, format);
200 ndr->private_data = talloc_vasprintf_append_buffer((char *)ndr->private_data,
201 format, ap);
202 va_end(ap);
203 ndr->private_data = talloc_asprintf_append_buffer((char *)ndr->private_data,
204 "\n");
205 }
206
207 /*
208 a useful helper function for printing idl structures via DEBUG()
209 */
210 _PUBLIC_ void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr)
211 {
212 struct ndr_print *ndr;
213
214 DEBUG(1,(" "));
215
216 ndr = talloc_zero(NULL, struct ndr_print);
217 if (!ndr) return;
218 ndr->print = ndr_print_debug_helper;
219 ndr->depth = 1;
220 ndr->flags = 0;
221 fn(ndr, name, ptr);
222 talloc_free(ndr);
223 }
224
225 /*
226 a useful helper function for printing idl unions via DEBUG()
227 */
228 _PUBLIC_ void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
229 {
230 struct ndr_print *ndr;
231
232 DEBUG(1,(" "));
233
234 ndr = talloc_zero(NULL, struct ndr_print);
235 if (!ndr) return;
236 ndr->print = ndr_print_debug_helper;
237 ndr->depth = 1;
238 ndr->flags = 0;
239 ndr_print_set_switch_value(ndr, ptr, level);
240 fn(ndr, name, ptr);
241 talloc_free(ndr);
242 }
243
244 /*
245 a useful helper function for printing idl function calls via DEBUG()
246 */
247 _PUBLIC_ void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr)
248 {
249 struct ndr_print *ndr;
250
251 DEBUG(1,(" "));
252
253 ndr = talloc_zero(NULL, struct ndr_print);
254 if (!ndr) return;
255 ndr->print = ndr_print_debug_helper;
256 ndr->depth = 1;
257 ndr->flags = 0;
258 fn(ndr, name, flags, ptr);
259 talloc_free(ndr);
260 }
261
262 /*
263 a useful helper function for printing idl structures to a string
264 */
265 _PUBLIC_ char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr)
266 {
267 struct ndr_print *ndr;
268 char *ret = NULL;
269
270 ndr = talloc_zero(mem_ctx, struct ndr_print);
271 if (!ndr) return NULL;
272 ndr->private_data = talloc_strdup(ndr, "");
273 if (!ndr->private_data) {
274 goto failed;
275 }
276 ndr->print = ndr_print_string_helper;
277 ndr->depth = 1;
278 ndr->flags = 0;
279 fn(ndr, name, ptr);
280 ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
281 failed:
282 talloc_free(ndr);
283 return ret;
284 }
285
286 /*
287 a useful helper function for printing idl unions to a string
288 */
289 _PUBLIC_ char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
290 {
291 struct ndr_print *ndr;
292 char *ret = NULL;
293
294 ndr = talloc_zero(mem_ctx, struct ndr_print);
295 if (!ndr) return NULL;
296 ndr->private_data = talloc_strdup(ndr, "");
297 if (!ndr->private_data) {
298 goto failed;
299 }
300 ndr->print = ndr_print_string_helper;
301 ndr->depth = 1;
302 ndr->flags = 0;
303 ndr_print_set_switch_value(ndr, ptr, level);
304 fn(ndr, name, ptr);
305 ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
306 failed:
307 talloc_free(ndr);
308 return ret;
309 }
310
311 /*
312 a useful helper function for printing idl function calls to a string
313 */
314 _PUBLIC_ char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
315 ndr_print_function_t fn, const char *name,
316 int flags, void *ptr)
317 {
318 struct ndr_print *ndr;
319 char *ret = NULL;
320
321 ndr = talloc_zero(mem_ctx, struct ndr_print);
322 if (!ndr) return NULL;
323 ndr->private_data = talloc_strdup(ndr, "");
324 if (!ndr->private_data) {
325 goto failed;
326 }
327 ndr->print = ndr_print_string_helper;
328 ndr->depth = 1;
329 ndr->flags = 0;
330 fn(ndr, name, flags, ptr);
331 ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
332 failed:
333 talloc_free(ndr);
334 return ret;
335 }
336
337 _PUBLIC_ void ndr_set_flags(uint32_t *pflags, uint32_t new_flags)
338 {
339 /* the big/little endian flags are inter-dependent */
340 if (new_flags & LIBNDR_FLAG_LITTLE_ENDIAN) {
341 (*pflags) &= ~LIBNDR_FLAG_BIGENDIAN;
342 }
343 if (new_flags & LIBNDR_FLAG_BIGENDIAN) {
344 (*pflags) &= ~LIBNDR_FLAG_LITTLE_ENDIAN;
345 }
346 if (new_flags & LIBNDR_FLAG_REMAINING) {
347 (*pflags) &= ~LIBNDR_ALIGN_FLAGS;
348 }
349 if (new_flags & LIBNDR_ALIGN_FLAGS) {
350 (*pflags) &= ~LIBNDR_FLAG_REMAINING;
351 }
352 if (new_flags & LIBNDR_FLAG_NO_RELATIVE_REVERSE) {
353 (*pflags) &= ~LIBNDR_FLAG_RELATIVE_REVERSE;
354 }
355 (*pflags) |= new_flags;
356 }
357
358 /*
359 return and possibly log an NDR error
360 */
361 _PUBLIC_ enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
362 enum ndr_err_code ndr_err,
363 const char *format, ...)
364 {
365 char *s=NULL;
366 va_list ap;
367 int ret;
368
369 va_start(ap, format);
370 ret = vasprintf(&s, format, ap);
371 va_end(ap);
372
373 if (ret == -1) {
374 return NDR_ERR_ALLOC;
375 }
376
377 DEBUG(1,("ndr_pull_error(%u): %s\n", ndr_err, s));
378
379 free(s);
380
381 return ndr_err;
382 }
383
384 /*
385 return and possibly log an NDR error
386 */
387 _PUBLIC_ enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
388 enum ndr_err_code ndr_err,
389 const char *format, ...)
390 {
391 char *s=NULL;
392 va_list ap;
393 int ret;
394
395 va_start(ap, format);
396 ret = vasprintf(&s, format, ap);
397 va_end(ap);
398
399 if (ret == -1) {
400 return NDR_ERR_ALLOC;
401 }
402
403 DEBUG(1,("ndr_push_error(%u): %s\n", ndr_err, s));
404
405 free(s);
406
407 return ndr_err;
408 }
409
410 /*
411 handle subcontext buffers, which in midl land are user-marshalled, but
412 we use magic in pidl to make them easier to cope with
413 */
414 _PUBLIC_ enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
415 struct ndr_pull **_subndr,
416 size_t header_size,
417 ssize_t size_is)
418 {
419 struct ndr_pull *subndr;
420 uint32_t r_content_size;
421 bool force_le = false;
422 bool force_be = false;
423
424 switch (header_size) {
425 case 0: {
426 uint32_t content_size = ndr->data_size - ndr->offset;
427 if (size_is >= 0) {
428 content_size = size_is;
429 }
430 r_content_size = content_size;
431 break;
432 }
433
434 case 2: {
435 uint16_t content_size;
436 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &content_size));
437 if (size_is >= 0 && size_is != content_size) {
438 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
439 (int)size_is, (int)content_size);
440 }
441 r_content_size = content_size;
442 break;
443 }
444
445 case 4: {
446 uint32_t content_size;
447 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
448 if (size_is >= 0 && size_is != content_size) {
449 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
450 (int)size_is, (int)content_size);
451 }
452 r_content_size = content_size;
453 break;
454 }
455 case 0xFFFFFC01: {
456 /*
457 * Common Type Header for the Serialization Stream
458 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
459 */
460 uint8_t version;
461 uint8_t drep;
462 uint16_t hdrlen;
463 uint32_t filler;
464 uint32_t content_size;
465 uint32_t reserved;
466
467 /* version */
468 NDR_CHECK(ndr_pull_uint8(ndr, NDR_SCALARS, &version));
469
470 if (version != 1) {
471 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
472 "Bad subcontext (PULL) Common Type Header version %d != 1",
473 (int)version);
474 }
475
476 /*
477 * 0x10 little endian
478 * 0x00 big endian
479 */
480 NDR_CHECK(ndr_pull_uint8(ndr, NDR_SCALARS, &drep));
481 if (drep == 0x10) {
482 force_le = true;
483 } else if (drep == 0x00) {
484 force_be = true;
485 } else {
486 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
487 "Bad subcontext (PULL) Common Type Header invalid drep 0x%02X",
488 (unsigned int)drep);
489 }
490
491 /* length of the "Private Header for Constructed Type" */
492 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &hdrlen));
493 if (hdrlen != 8) {
494 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
495 "Bad subcontext (PULL) Common Type Header length %d != 8",
496 (int)hdrlen);
497 }
498
499 /* filler should be ignored */
500 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &filler));
501
502 /*
503 * Private Header for Constructed Type
504 */
505 /* length - will be updated latter */
506 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
507 if (size_is >= 0 && size_is != content_size) {
508 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
509 (int)size_is, (int)content_size);
510 }
511 /* the content size must be a multiple of 8 */
512 if ((content_size % 8) != 0) {
513 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
514 "Bad subcontext (PULL) size_is(%d) not padded to 8 content_size %d",
515 (int)size_is, (int)content_size);
516 }
517 r_content_size = content_size;
518
519 /* reserved */
520 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &reserved));
521 break;
522 }
523 default:
524 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) header_size %d",
525 (int)header_size);
526 }
527
528 NDR_PULL_NEED_BYTES(ndr, r_content_size);
529
530 subndr = talloc_zero(ndr, struct ndr_pull);
531 NDR_ERR_HAVE_NO_MEMORY(subndr);
532 subndr->flags = ndr->flags;
533 subndr->current_mem_ctx = ndr->current_mem_ctx;
534
535 subndr->data = ndr->data + ndr->offset;
536 subndr->offset = 0;
537 subndr->data_size = r_content_size;
538 subndr->iconv_convenience = talloc_reference(subndr, ndr->iconv_convenience);
539
540 if (force_le) {
541 ndr_set_flags(&ndr->flags, LIBNDR_FLAG_LITTLE_ENDIAN);
542 } else if (force_be) {
543 ndr_set_flags(&ndr->flags, LIBNDR_FLAG_BIGENDIAN);
544 }
545
546 *_subndr = subndr;
547 return NDR_ERR_SUCCESS;
548 }
549
550 _PUBLIC_ enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
551 struct ndr_pull *subndr,
552 size_t header_size,
553 ssize_t size_is)
554 {
555 uint32_t advance;
556 if (size_is >= 0) {
557 advance = size_is;
558 } else if (header_size > 0) {
559 advance = subndr->data_size;
560 } else {
561 advance = subndr->offset;
562 }
563 NDR_CHECK(ndr_pull_advance(ndr, advance));
564 return NDR_ERR_SUCCESS;
565 }
566
567 _PUBLIC_ enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
568 struct ndr_push **_subndr,
569 size_t header_size,
570 ssize_t size_is)
571 {
572 struct ndr_push *subndr;
573
574 subndr = ndr_push_init_ctx(ndr, ndr->iconv_convenience);
575 NDR_ERR_HAVE_NO_MEMORY(subndr);
576 subndr->flags = ndr->flags;
577
578 if (size_is > 0) {
579 NDR_CHECK(ndr_push_zero(subndr, size_is));
580 subndr->offset = 0;
581 }
582
583 *_subndr = subndr;
584 return NDR_ERR_SUCCESS;
585 }
586
587 /*
588 push a subcontext header
589 */
590 _PUBLIC_ enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
591 struct ndr_push *subndr,
592 size_t header_size,
593 ssize_t size_is)
594 {
595 ssize_t padding_len;
596
597 if (size_is >= 0) {
598 padding_len = size_is - subndr->offset;
599 if (padding_len < 0) {
600 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
601 (int)subndr->offset, (int)size_is);
602 }
603 subndr->offset = size_is;
604 }
605
606 switch (header_size) {
607 case 0:
608 break;
609
610 case 2:
611 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, subndr->offset));
612 break;
613
614 case 4:
615 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, subndr->offset));
616 break;
617
618 case 0xFFFFFC01:
619 /*
620 * Common Type Header for the Serialization Stream
621 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
622 */
623 padding_len = NDR_ROUND(subndr->offset, 8) - subndr->offset;
624 if (padding_len > 0) {
625 NDR_CHECK(ndr_push_zero(subndr, padding_len));
626 }
627
628 /* version */
629 NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 1));
630
631 /*
632 * 0x10 little endian
633 * 0x00 big endian
634 */
635 NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, NDR_BE(ndr)?0x00:0x10));
636
637 /* length of the "Private Header for Constructed Type" */
638 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, 8));
639
640 /* filler */
641 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0xCCCCCCCC));
642
643 /*
644 * Private Header for Constructed Type
645 */
646 /* length - will be updated latter */
647 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, subndr->offset));
648
649 /* reserved */
650 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
651 break;
652
653 default:
654 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext header size %d",
655 (int)header_size);
656 }
657
658 NDR_CHECK(ndr_push_bytes(ndr, subndr->data, subndr->offset));
659 return NDR_ERR_SUCCESS;
660 }
661
662 /*
663 store a token in the ndr context, for later retrieval
664 */
665 _PUBLIC_ enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
666 struct ndr_token_list **list,
667 const void *key,
668 uint32_t value)
669 {
670 struct ndr_token_list *tok;
671 tok = talloc(mem_ctx, struct ndr_token_list);
672 NDR_ERR_HAVE_NO_MEMORY(tok);
673 tok->key = key;
674 tok->value = value;
675 DLIST_ADD((*list), tok);
676 return NDR_ERR_SUCCESS;
677 }
678
679 /*
680 retrieve a token from a ndr context, using cmp_fn to match the tokens
681 */
682 _PUBLIC_ enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list **list, const void *key, uint32_t *v,
683 comparison_fn_t _cmp_fn, bool _remove_tok)
684 {
685 struct ndr_token_list *tok;
686 for (tok=*list;tok;tok=tok->next) {
687 if (_cmp_fn && _cmp_fn(tok->key,key)==0) goto found;
688 else if (!_cmp_fn && tok->key == key) goto found;
689 }
690 return NDR_ERR_TOKEN;
691 found:
692 *v = tok->value;
693 if (_remove_tok) {
694 DLIST_REMOVE((*list), tok);
695 talloc_free(tok);
696 }
697 return NDR_ERR_SUCCESS;
698 }
699
700 /*
701 retrieve a token from a ndr context
702 */
703 _PUBLIC_ enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
704 {
705 return ndr_token_retrieve_cmp_fn(list, key, v, NULL, true);
706 }
707
708 /*
709 peek at but don't removed a token from a ndr context
710 */
711 _PUBLIC_ uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
712 {
713 enum ndr_err_code status;
714 uint32_t v;
715
716 status = ndr_token_retrieve_cmp_fn(list, key, &v, NULL, false);
717 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
718 return 0;
719 }
720
721 return v;
722 }
723
724 /*
725 pull an array size field and add it to the array_size_list token list
726 */
727 _PUBLIC_ enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
728 {
729 uint32_t size;
730 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
731 return ndr_token_store(ndr, &ndr->array_size_list, p, size);
732 }
733
734 /*
735 get the stored array size field
736 */
737 _PUBLIC_ uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
738 {
739 return ndr_token_peek(&ndr->array_size_list, p);
740 }
741
742 /*
743 check the stored array size field
744 */
745 _PUBLIC_ enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
746 {
747 uint32_t stored;
748 stored = ndr_token_peek(&ndr->array_size_list, p);
749 if (stored != size) {
750 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
751 "Bad array size - got %u expected %u\n",
752 stored, size);
753 }
754 return NDR_ERR_SUCCESS;
755 }
756
757 /*
758 pull an array length field and add it to the array_length_list token list
759 */
760 _PUBLIC_ enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
761 {
762 uint32_t length, offset;
763 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &offset));
764 if (offset != 0) {
765 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
766 "non-zero array offset %u\n", offset);
767 }
768 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
769 return ndr_token_store(ndr, &ndr->array_length_list, p, length);
770 }
771
772 /*
773 get the stored array length field
774 */
775 _PUBLIC_ uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
776 {
777 return ndr_token_peek(&ndr->array_length_list, p);
778 }
779
780 /*
781 check the stored array length field
782 */
783 _PUBLIC_ enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
784 {
785 uint32_t stored;
786 stored = ndr_token_peek(&ndr->array_length_list, p);
787 if (stored != length) {
788 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
789 "Bad array length - got %u expected %u\n",
790 stored, length);
791 }
792 return NDR_ERR_SUCCESS;
793 }
794
795 /*
796 store a switch value
797 */
798 _PUBLIC_ enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val)
799 {
800 return ndr_token_store(ndr, &ndr->switch_list, p, val);
801 }
802
803 _PUBLIC_ enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val)
804 {
805 return ndr_token_store(ndr, &ndr->switch_list, p, val);
806 }
807
808 _PUBLIC_ enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val)
809 {
810 return ndr_token_store(ndr, &ndr->switch_list, p, val);
811 }
812
813 /*
814 retrieve a switch value
815 */
816 _PUBLIC_ uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p)
817 {
818 return ndr_token_peek(&ndr->switch_list, p);
819 }
820
821 _PUBLIC_ uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p)
822 {
823 return ndr_token_peek(&ndr->switch_list, p);
824 }
825
826 _PUBLIC_ uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p)
827 {
828 return ndr_token_peek(&ndr->switch_list, p);
829 }
830
831 /*
832 pull a struct from a blob using NDR
833 */
834 _PUBLIC_ enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, void *p,
835 ndr_pull_flags_fn_t fn)
836 {
837 struct ndr_pull *ndr;
838 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
839 NDR_ERR_HAVE_NO_MEMORY(ndr);
840 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
841 return NDR_ERR_SUCCESS;
842 }
843
844 /*
845 pull a struct from a blob using NDR - failing if all bytes are not consumed
846 */
847 _PUBLIC_ enum ndr_err_code ndr_pull_struct_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
848 struct smb_iconv_convenience *iconv_convenience,
849 void *p, ndr_pull_flags_fn_t fn)
850 {
851 struct ndr_pull *ndr;
852 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
853 NDR_ERR_HAVE_NO_MEMORY(ndr);
854 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
855 if (ndr->offset < ndr->data_size) {
856 return ndr_pull_error(ndr, NDR_ERR_UNREAD_BYTES,
857 "not all bytes consumed ofs[%u] size[%u]",
858 ndr->offset, ndr->data_size);
859 }
860 return NDR_ERR_SUCCESS;
861 }
862
863 /*
864 pull a union from a blob using NDR, given the union discriminator
865 */
866 _PUBLIC_ enum ndr_err_code ndr_pull_union_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
867 struct smb_iconv_convenience *iconv_convenience, void *p,
868 uint32_t level, ndr_pull_flags_fn_t fn)
869 {
870 struct ndr_pull *ndr;
871 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
872 NDR_ERR_HAVE_NO_MEMORY(ndr);
873 NDR_CHECK(ndr_pull_set_switch_value(ndr, p, level));
874 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
875 return NDR_ERR_SUCCESS;
876 }
877
878 /*
879 pull a union from a blob using NDR, given the union discriminator,
880 failing if all bytes are not consumed
881 */
882 _PUBLIC_ enum ndr_err_code ndr_pull_union_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
883 struct smb_iconv_convenience *iconv_convenience, void *p,
884 uint32_t level, ndr_pull_flags_fn_t fn)
885 {
886 struct ndr_pull *ndr;
887 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
888 NDR_ERR_HAVE_NO_MEMORY(ndr);
889 NDR_CHECK(ndr_pull_set_switch_value(ndr, p, level));
890 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
891 if (ndr->offset < ndr->data_size) {
892 return ndr_pull_error(ndr, NDR_ERR_UNREAD_BYTES,
893 "not all bytes consumed ofs[%u] size[%u]",
894 ndr->offset, ndr->data_size);
895 }
896 return NDR_ERR_SUCCESS;
897 }
898
899 /*
900 push a struct to a blob using NDR
901 */
902 _PUBLIC_ enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, const void *p, ndr_push_flags_fn_t fn)
903 {
904 struct ndr_push *ndr;
905 ndr = ndr_push_init_ctx(mem_ctx, iconv_convenience);
906 NDR_ERR_HAVE_NO_MEMORY(ndr);
907
908 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
909
910 *blob = ndr_push_blob(ndr);
911 talloc_steal(mem_ctx, blob->data);
912 talloc_free(ndr);
913
914 return NDR_ERR_SUCCESS;
915 }
916
917 /*
918 push a union to a blob using NDR
919 */
920 _PUBLIC_ enum ndr_err_code ndr_push_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, void *p,
921 uint32_t level, ndr_push_flags_fn_t fn)
922 {
923 struct ndr_push *ndr;
924 ndr = ndr_push_init_ctx(mem_ctx, iconv_convenience);
925 NDR_ERR_HAVE_NO_MEMORY(ndr);
926
927 NDR_CHECK(ndr_push_set_switch_value(ndr, p, level));
928 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
929
930 *blob = ndr_push_blob(ndr);
931 talloc_steal(mem_ctx, blob->data);
932 talloc_free(ndr);
933
934 return NDR_ERR_SUCCESS;
935 }
936
937 /*
938 generic ndr_size_*() handler for structures
939 */
940 _PUBLIC_ size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push, struct smb_iconv_convenience *iconv_convenience)
941 {
942 struct ndr_push *ndr;
943 enum ndr_err_code status;
944 size_t ret;
945
946 /* avoid recursion */
947 if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
948
949 ndr = ndr_push_init_ctx(NULL, iconv_convenience);
950 if (!ndr) return 0;
951 ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
952 status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
953 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
954 talloc_free(ndr);
955 return 0;
956 }
957 ret = ndr->offset;
958 talloc_free(ndr);
959 return ret;
960 }
961
962 /*
963 generic ndr_size_*() handler for unions
964 */
965 _PUBLIC_ size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push, struct smb_iconv_convenience *iconv_convenience)
966 {
967 struct ndr_push *ndr;
968 enum ndr_err_code status;
969 size_t ret;
970
971 /* avoid recursion */
972 if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
973
974 ndr = ndr_push_init_ctx(NULL, iconv_convenience);
975 if (!ndr) return 0;
976 ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
977
978 status = ndr_push_set_switch_value(ndr, p, level);
979 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
980 talloc_free(ndr);
981 return 0;
982 }
983 status = push(ndr, NDR_SCALARS|NDR_BUFFERS, p);
984 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
985 talloc_free(ndr);
986 return 0;
987 }
988 ret = ndr->offset;
989 talloc_free(ndr);
990 return ret;
991 }
992
993 /*
994 get the current base for relative pointers for the push
995 */
996 _PUBLIC_ uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr)
997 {
998 return ndr->relative_base_offset;
999 }
1000
1001 /*
1002 restore the old base for relative pointers for the push
1003 */
1004 _PUBLIC_ void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset)
1005 {
1006 ndr->relative_base_offset = offset;
1007 }
1008
1009 /*
1010 setup the current base for relative pointers for the push
1011 called in the NDR_SCALAR stage
1012 */
1013 _PUBLIC_ enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset)
1014 {
1015 ndr->relative_base_offset = offset;
1016 return ndr_token_store(ndr, &ndr->relative_base_list, p, offset);
1017 }
1018
1019 /*
1020 setup the current base for relative pointers for the push
1021 called in the NDR_BUFFERS stage
1022 */
1023 _PUBLIC_ enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p)
1024 {
1025 return ndr_token_retrieve(&ndr->relative_base_list, p, &ndr->relative_base_offset);
1026 }
1027
1028 /*
1029 push a relative object - stage1
1030 this is called during SCALARS processing
1031 */
1032 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p)
1033 {
1034 if (p == NULL) {
1035 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
1036 return NDR_ERR_SUCCESS;
1037 }
1038 NDR_CHECK(ndr_push_align(ndr, 4));
1039 NDR_CHECK(ndr_token_store(ndr, &ndr->relative_list, p, ndr->offset));
1040 return ndr_push_uint32(ndr, NDR_SCALARS, 0xFFFFFFFF);
1041 }
1042
1043 /*
1044 push a relative object - stage2
1045 this is called during buffers processing
1046 */
1047 static enum ndr_err_code ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p)
1048 {
1049 uint32_t save_offset;
1050 uint32_t ptr_offset = 0xFFFFFFFF;
1051 if (p == NULL) {
1052 return NDR_ERR_SUCCESS;
1053 }
1054 save_offset = ndr->offset;
1055 NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ptr_offset));
1056 if (ptr_offset > ndr->offset) {
1057 return ndr_push_error(ndr, NDR_ERR_BUFSIZE,
1058 "ndr_push_relative_ptr2 ptr_offset(%u) > ndr->offset(%u)",
1059 ptr_offset, ndr->offset);
1060 }
1061 ndr->offset = ptr_offset;
1062 if (save_offset < ndr->relative_base_offset) {
1063 return ndr_push_error(ndr, NDR_ERR_BUFSIZE,
1064 "ndr_push_relative_ptr2 save_offset(%u) < ndr->relative_base_offset(%u)",
1065 save_offset, ndr->relative_base_offset);
1066 }
1067 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save_offset - ndr->relative_base_offset));
1068 ndr->offset = save_offset;
1069 return NDR_ERR_SUCCESS;
1070 }
1071
1072 /*
1073 push a relative object - stage2 start
1074 this is called during buffers processing
1075 */
1076 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p)
1077 {
1078 if (p == NULL) {
1079 return NDR_ERR_SUCCESS;
1080 }
1081 return ndr_push_relative_ptr2(ndr, p);
1082 }
1083
1084 /*
1085 push a relative object - stage2 end
1086 this is called during buffers processing
1087 */
1088 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p)
1089 {
1090 if (p == NULL) {
1091 return NDR_ERR_SUCCESS;
1092 }
1093 return NDR_ERR_SUCCESS;
1094 }
1095
1096 /*
1097 get the current base for relative pointers for the pull
1098 */
1099 _PUBLIC_ uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr)
1100 {
1101 return ndr->relative_base_offset;
1102 }
1103
1104 /*
1105 restore the old base for relative pointers for the pull
1106 */
1107 _PUBLIC_ void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset)
1108 {
1109 ndr->relative_base_offset = offset;
1110 }
1111
1112 /*
1113 setup the current base for relative pointers for the pull
1114 called in the NDR_SCALAR stage
1115 */
1116 _PUBLIC_ enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset)
1117 {
1118 ndr->relative_base_offset = offset;
1119 return ndr_token_store(ndr, &ndr->relative_base_list, p, offset);
1120 }
1121
1122 /*
1123 setup the current base for relative pointers for the pull
1124 called in the NDR_BUFFERS stage
1125 */
1126 _PUBLIC_ enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p)
1127 {
1128 return ndr_token_retrieve(&ndr->relative_base_list, p, &ndr->relative_base_offset);
1129 }
1130
1131 /*
1132 pull a relative object - stage1
1133 called during SCALARS processing
1134 */
1135 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
1136 {
1137 rel_offset += ndr->relative_base_offset;
1138 if (rel_offset > ndr->data_size) {
1139 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
1140 "ndr_pull_relative_ptr1 rel_offset(%u) > ndr->data_size(%u)",
1141 rel_offset, ndr->data_size);
1142 }
1143 return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
1144 }
1145
1146 /*
1147 pull a relative object - stage2
1148 called during BUFFERS processing
1149 */
1150 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p)
1151 {
1152 uint32_t rel_offset;
1153 NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
1154 return ndr_pull_set_offset(ndr, rel_offset);
1155 }
1156
1157 const static struct {
1158 enum ndr_err_code err;
1159 const char *string;
1160 } ndr_err_code_strings[] = {
1161 { NDR_ERR_SUCCESS, "Success" },
1162 { NDR_ERR_ARRAY_SIZE, "Bad Array Size" },
1163 { NDR_ERR_BAD_SWITCH, "Bad Switch" },
1164 { NDR_ERR_OFFSET, "Offset Error" },
1165 { NDR_ERR_RELATIVE, "Relative Pointer Error" },
1166 { NDR_ERR_CHARCNV, "Character Conversion Error" },
1167 { NDR_ERR_LENGTH, "Length Error" },
1168 { NDR_ERR_SUBCONTEXT, "Subcontext Error" },
1169 { NDR_ERR_COMPRESSION, "Compression Error" },
1170 { NDR_ERR_STRING, "String Error" },
1171 { NDR_ERR_VALIDATE, "Validate Error" },
1172 { NDR_ERR_BUFSIZE, "Buffer Size Error" },
1173 { NDR_ERR_ALLOC, "Allocation Error" },
1174 { NDR_ERR_RANGE, "Range Error" },
1175 { NDR_ERR_TOKEN, "Token Error" },
1176 { NDR_ERR_IPV4ADDRESS, "IPv4 Address Error" },
1177 { NDR_ERR_INVALID_POINTER, "Invalid Pointer" },
1178 { NDR_ERR_UNREAD_BYTES, "Unread Bytes" },
1179 { 0, NULL }
1180 };
1181
1182 _PUBLIC_ const char *ndr_map_error2string(enum ndr_err_code ndr_err)
1183 {
1184 int i;
1185 for (i = 0; ndr_err_code_strings[i].string != NULL; i++) {
1186 if (ndr_err_code_strings[i].err == ndr_err)
1187 return ndr_err_code_strings[i].string;
1188 }
1189 return "Unknown error";
1190 }
Samba GIT mirror