2 Unix SMB/CIFS implementation.
6 Copyright (C) Andrew Tridgell 2003
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.
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.
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/>.
23 this provides the core routines for NDR parsing functions
25 see http://www.opengroup.org/onlinepubs/9629399/chap14.htm for details
30 #include "librpc/ndr/libndr.h"
31 #include "../lib/util/dlinklist.h"
32 #if _SAMBA_BUILD_ == 4
33 #include "param/param.h"
36 #define NDR_BASE_MARSHALL_SIZE 1024
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} },
44 const struct ndr_syntax_id ndr64_transfer_syntax = {
45 { 0x71710533, 0xbeba, 0x4937, {0x83, 0x19}, {0xb5,0xdb,0xef,0x9c,0xcc,0x36} },
50 work out the number of bytes needed to align on a n byte boundary
52 _PUBLIC_ size_t ndr_align_size(uint32_t offset, size_t n)
54 if ((offset & (n-1)) == 0) return 0;
55 return n - (offset & (n-1));
59 initialise a ndr parse structure from a data blob
61 _PUBLIC_ struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience)
65 ndr = talloc_zero(mem_ctx, struct ndr_pull);
66 if (!ndr) return NULL;
67 ndr->current_mem_ctx = mem_ctx;
69 ndr->data = blob->data;
70 ndr->data_size = blob->length;
71 ndr->iconv_convenience = talloc_reference(ndr, iconv_convenience);
77 advance by 'size' bytes
79 _PUBLIC_ enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size)
82 if (ndr->offset > ndr->data_size) {
83 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
84 "ndr_pull_advance by %u failed",
87 return NDR_ERR_SUCCESS;
91 set the parse offset to 'ofs'
93 static enum ndr_err_code ndr_pull_set_offset(struct ndr_pull *ndr, uint32_t ofs)
96 if (ndr->offset > ndr->data_size) {
97 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
98 "ndr_pull_set_offset %u failed",
101 return NDR_ERR_SUCCESS;
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)
107 struct ndr_push *ndr;
109 ndr = talloc_zero(mem_ctx, struct ndr_push);
115 ndr->alloc_size = NDR_BASE_MARSHALL_SIZE;
116 ndr->data = talloc_array(ndr, uint8_t, ndr->alloc_size);
120 ndr->iconv_convenience = talloc_reference(ndr, iconv_convenience);
125 /* return a DATA_BLOB structure for the current ndr_push marshalled data */
126 _PUBLIC_ DATA_BLOB ndr_push_blob(struct ndr_push *ndr)
129 blob = data_blob_const(ndr->data, ndr->offset);
130 if (ndr->alloc_size > ndr->offset) {
131 ndr->data[ndr->offset] = 0;
138 expand the available space in the buffer to ndr->offset + extra_size
140 _PUBLIC_ enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size)
142 uint32_t size = extra_size + ndr->offset;
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",
150 if (ndr->alloc_size > size) {
151 return NDR_ERR_SUCCESS;
154 ndr->alloc_size += NDR_BASE_MARSHALL_SIZE;
155 if (size+1 > ndr->alloc_size) {
156 ndr->alloc_size = size+1;
158 ndr->data = talloc_realloc(ndr, ndr->data, uint8_t, ndr->alloc_size);
160 return ndr_push_error(ndr, NDR_ERR_ALLOC, "Failed to push_expand to %u",
164 return NDR_ERR_SUCCESS;
167 _PUBLIC_ void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...)
173 va_start(ap, format);
174 ret = vasprintf(&s, format, ap);
181 for (i=0;i<ndr->depth;i++) {
185 DEBUGADD(1,("%s\n", s));
189 _PUBLIC_ void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...)
194 for (i=0;i<ndr->depth;i++) {
195 ndr->private_data = talloc_asprintf_append_buffer(
196 (char *)ndr->private_data, " ");
199 va_start(ap, format);
200 ndr->private_data = talloc_vasprintf_append_buffer((char *)ndr->private_data,
203 ndr->private_data = talloc_asprintf_append_buffer((char *)ndr->private_data,
208 a useful helper function for printing idl structures via DEBUG()
210 _PUBLIC_ void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr)
212 struct ndr_print *ndr;
216 ndr = talloc_zero(NULL, struct ndr_print);
218 ndr->print = ndr_print_debug_helper;
226 a useful helper function for printing idl unions via DEBUG()
228 _PUBLIC_ void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
230 struct ndr_print *ndr;
234 ndr = talloc_zero(NULL, struct ndr_print);
236 ndr->print = ndr_print_debug_helper;
239 ndr_print_set_switch_value(ndr, ptr, level);
245 a useful helper function for printing idl function calls via DEBUG()
247 _PUBLIC_ void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr)
249 struct ndr_print *ndr;
253 ndr = talloc_zero(NULL, struct ndr_print);
255 ndr->print = ndr_print_debug_helper;
258 ndr->iconv_convenience = smb_iconv_convenience_init(talloc_autofree_context(), "ASCII", "UTF-8", true);
259 fn(ndr, name, flags, ptr);
264 a useful helper function for printing idl structures to a string
266 _PUBLIC_ char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr)
268 struct ndr_print *ndr;
271 ndr = talloc_zero(mem_ctx, struct ndr_print);
272 if (!ndr) return NULL;
273 ndr->private_data = talloc_strdup(ndr, "");
274 if (!ndr->private_data) {
277 ndr->print = ndr_print_string_helper;
281 ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
288 a useful helper function for printing idl unions to a string
290 _PUBLIC_ char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
292 struct ndr_print *ndr;
295 ndr = talloc_zero(mem_ctx, struct ndr_print);
296 if (!ndr) return NULL;
297 ndr->private_data = talloc_strdup(ndr, "");
298 if (!ndr->private_data) {
301 ndr->print = ndr_print_string_helper;
304 ndr_print_set_switch_value(ndr, ptr, level);
306 ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
313 a useful helper function for printing idl function calls to a string
315 _PUBLIC_ char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
316 ndr_print_function_t fn, const char *name,
317 int flags, void *ptr)
319 struct ndr_print *ndr;
322 ndr = talloc_zero(mem_ctx, struct ndr_print);
323 if (!ndr) return NULL;
324 ndr->private_data = talloc_strdup(ndr, "");
325 if (!ndr->private_data) {
328 ndr->print = ndr_print_string_helper;
331 fn(ndr, name, flags, ptr);
332 ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
338 _PUBLIC_ void ndr_set_flags(uint32_t *pflags, uint32_t new_flags)
340 /* the big/little endian flags are inter-dependent */
341 if (new_flags & LIBNDR_FLAG_LITTLE_ENDIAN) {
342 (*pflags) &= ~LIBNDR_FLAG_BIGENDIAN;
344 if (new_flags & LIBNDR_FLAG_BIGENDIAN) {
345 (*pflags) &= ~LIBNDR_FLAG_LITTLE_ENDIAN;
347 if (new_flags & LIBNDR_FLAG_REMAINING) {
348 (*pflags) &= ~LIBNDR_ALIGN_FLAGS;
350 if (new_flags & LIBNDR_ALIGN_FLAGS) {
351 (*pflags) &= ~LIBNDR_FLAG_REMAINING;
353 (*pflags) |= new_flags;
357 return and possibly log an NDR error
359 _PUBLIC_ enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
360 enum ndr_err_code ndr_err,
361 const char *format, ...)
367 va_start(ap, format);
368 ret = vasprintf(&s, format, ap);
372 return NDR_ERR_ALLOC;
375 DEBUG(1,("ndr_pull_error(%u): %s\n", ndr_err, s));
383 return and possibly log an NDR error
385 _PUBLIC_ enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
386 enum ndr_err_code ndr_err,
387 const char *format, ...)
393 va_start(ap, format);
394 ret = vasprintf(&s, format, ap);
398 return NDR_ERR_ALLOC;
401 DEBUG(1,("ndr_push_error(%u): %s\n", ndr_err, s));
409 handle subcontext buffers, which in midl land are user-marshalled, but
410 we use magic in pidl to make them easier to cope with
412 _PUBLIC_ enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
413 struct ndr_pull **_subndr,
417 struct ndr_pull *subndr;
418 uint32_t r_content_size;
419 bool force_le = false;
420 bool force_be = false;
422 switch (header_size) {
424 uint32_t content_size = ndr->data_size - ndr->offset;
426 content_size = size_is;
428 r_content_size = content_size;
433 uint16_t content_size;
434 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &content_size));
435 if (size_is >= 0 && size_is != content_size) {
436 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
437 (int)size_is, (int)content_size);
439 r_content_size = content_size;
444 uint32_t content_size;
445 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
446 if (size_is >= 0 && size_is != content_size) {
447 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
448 (int)size_is, (int)content_size);
450 r_content_size = content_size;
455 * Common Type Header for the Serialization Stream
456 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
462 uint32_t content_size;
466 NDR_CHECK(ndr_pull_uint8(ndr, NDR_SCALARS, &version));
469 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
470 "Bad subcontext (PULL) Common Type Header version %d != 1",
478 NDR_CHECK(ndr_pull_uint8(ndr, NDR_SCALARS, &drep));
481 } else if (drep == 0x00) {
484 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
485 "Bad subcontext (PULL) Common Type Header invalid drep 0x%02X",
489 /* length of the "Private Header for Constructed Type" */
490 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &hdrlen));
492 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
493 "Bad subcontext (PULL) Common Type Header length %d != 8",
497 /* filler should be ignored */
498 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &filler));
501 * Private Header for Constructed Type
503 /* length - will be updated latter */
504 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
505 if (size_is >= 0 && size_is != content_size) {
506 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
507 (int)size_is, (int)content_size);
509 /* the content size must be a multiple of 8 */
510 if ((content_size % 8) != 0) {
511 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
512 "Bad subcontext (PULL) size_is(%d) not padded to 8 content_size %d",
513 (int)size_is, (int)content_size);
515 r_content_size = content_size;
518 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &reserved));
522 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) header_size %d",
526 NDR_PULL_NEED_BYTES(ndr, r_content_size);
528 subndr = talloc_zero(ndr, struct ndr_pull);
529 NDR_ERR_HAVE_NO_MEMORY(subndr);
530 subndr->flags = ndr->flags;
531 subndr->current_mem_ctx = ndr->current_mem_ctx;
533 subndr->data = ndr->data + ndr->offset;
535 subndr->data_size = r_content_size;
536 subndr->iconv_convenience = talloc_reference(subndr, ndr->iconv_convenience);
539 ndr_set_flags(&ndr->flags, LIBNDR_FLAG_LITTLE_ENDIAN);
540 } else if (force_be) {
541 ndr_set_flags(&ndr->flags, LIBNDR_FLAG_BIGENDIAN);
545 return NDR_ERR_SUCCESS;
548 _PUBLIC_ enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
549 struct ndr_pull *subndr,
556 } else if (header_size > 0) {
557 advance = subndr->data_size;
559 advance = subndr->offset;
561 NDR_CHECK(ndr_pull_advance(ndr, advance));
562 return NDR_ERR_SUCCESS;
565 _PUBLIC_ enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
566 struct ndr_push **_subndr,
570 struct ndr_push *subndr;
572 subndr = ndr_push_init_ctx(ndr, ndr->iconv_convenience);
573 NDR_ERR_HAVE_NO_MEMORY(subndr);
574 subndr->flags = ndr->flags;
577 return NDR_ERR_SUCCESS;
581 push a subcontext header
583 _PUBLIC_ enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
584 struct ndr_push *subndr,
591 padding_len = size_is - subndr->offset;
592 if (padding_len > 0) {
593 NDR_CHECK(ndr_push_zero(subndr, padding_len));
594 } else if (padding_len < 0) {
595 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
596 (int)subndr->offset, (int)size_is);
600 switch (header_size) {
605 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, subndr->offset));
609 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, subndr->offset));
614 * Common Type Header for the Serialization Stream
615 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
617 padding_len = NDR_ROUND(subndr->offset, 8) - subndr->offset;
618 if (padding_len > 0) {
619 NDR_CHECK(ndr_push_zero(subndr, padding_len));
623 NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 1));
629 NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, NDR_BE(ndr)?0x00:0x10));
631 /* length of the "Private Header for Constructed Type" */
632 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, 8));
635 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0xCCCCCCCC));
638 * Private Header for Constructed Type
640 /* length - will be updated latter */
641 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, subndr->offset));
644 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
648 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext header size %d",
652 NDR_CHECK(ndr_push_bytes(ndr, subndr->data, subndr->offset));
653 return NDR_ERR_SUCCESS;
657 store a token in the ndr context, for later retrieval
659 _PUBLIC_ enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
660 struct ndr_token_list **list,
664 struct ndr_token_list *tok;
665 tok = talloc(mem_ctx, struct ndr_token_list);
666 NDR_ERR_HAVE_NO_MEMORY(tok);
669 DLIST_ADD((*list), tok);
670 return NDR_ERR_SUCCESS;
674 retrieve a token from a ndr context, using cmp_fn to match the tokens
676 _PUBLIC_ enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list **list, const void *key, uint32_t *v,
677 comparison_fn_t _cmp_fn, bool _remove_tok)
679 struct ndr_token_list *tok;
680 for (tok=*list;tok;tok=tok->next) {
681 if (_cmp_fn && _cmp_fn(tok->key,key)==0) goto found;
682 else if (!_cmp_fn && tok->key == key) goto found;
684 return NDR_ERR_TOKEN;
688 DLIST_REMOVE((*list), tok);
691 return NDR_ERR_SUCCESS;
695 retrieve a token from a ndr context
697 _PUBLIC_ enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
699 return ndr_token_retrieve_cmp_fn(list, key, v, NULL, true);
703 peek at but don't removed a token from a ndr context
705 _PUBLIC_ uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
707 enum ndr_err_code status;
710 status = ndr_token_retrieve_cmp_fn(list, key, &v, NULL, false);
711 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
719 pull an array size field and add it to the array_size_list token list
721 _PUBLIC_ enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
724 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
725 return ndr_token_store(ndr, &ndr->array_size_list, p, size);
729 get the stored array size field
731 _PUBLIC_ uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
733 return ndr_token_peek(&ndr->array_size_list, p);
737 check the stored array size field
739 _PUBLIC_ enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
742 stored = ndr_token_peek(&ndr->array_size_list, p);
743 if (stored != size) {
744 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
745 "Bad array size - got %u expected %u\n",
748 return NDR_ERR_SUCCESS;
752 pull an array length field and add it to the array_length_list token list
754 _PUBLIC_ enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
756 uint32_t length, offset;
757 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &offset));
759 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
760 "non-zero array offset %u\n", offset);
762 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
763 return ndr_token_store(ndr, &ndr->array_length_list, p, length);
767 get the stored array length field
769 _PUBLIC_ uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
771 return ndr_token_peek(&ndr->array_length_list, p);
775 check the stored array length field
777 _PUBLIC_ enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
780 stored = ndr_token_peek(&ndr->array_length_list, p);
781 if (stored != length) {
782 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
783 "Bad array length - got %u expected %u\n",
786 return NDR_ERR_SUCCESS;
792 _PUBLIC_ enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val)
794 return ndr_token_store(ndr, &ndr->switch_list, p, val);
797 _PUBLIC_ enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val)
799 return ndr_token_store(ndr, &ndr->switch_list, p, val);
802 _PUBLIC_ enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val)
804 return ndr_token_store(ndr, &ndr->switch_list, p, val);
808 retrieve a switch value
810 _PUBLIC_ uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p)
812 return ndr_token_peek(&ndr->switch_list, p);
815 _PUBLIC_ uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p)
817 return ndr_token_peek(&ndr->switch_list, p);
820 _PUBLIC_ uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p)
822 return ndr_token_peek(&ndr->switch_list, p);
826 pull a struct from a blob using NDR
828 _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,
829 ndr_pull_flags_fn_t fn)
831 struct ndr_pull *ndr;
832 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
833 NDR_ERR_HAVE_NO_MEMORY(ndr);
834 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
835 return NDR_ERR_SUCCESS;
839 pull a struct from a blob using NDR - failing if all bytes are not consumed
841 _PUBLIC_ enum ndr_err_code ndr_pull_struct_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
842 struct smb_iconv_convenience *iconv_convenience,
843 void *p, ndr_pull_flags_fn_t fn)
845 struct ndr_pull *ndr;
846 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
847 NDR_ERR_HAVE_NO_MEMORY(ndr);
848 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
849 if (ndr->offset < ndr->data_size) {
850 return ndr_pull_error(ndr, NDR_ERR_UNREAD_BYTES,
851 "not all bytes consumed ofs[%u] size[%u]",
852 ndr->offset, ndr->data_size);
854 return NDR_ERR_SUCCESS;
858 pull a union from a blob using NDR, given the union discriminator
860 _PUBLIC_ enum ndr_err_code ndr_pull_union_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
861 struct smb_iconv_convenience *iconv_convenience, void *p,
862 uint32_t level, ndr_pull_flags_fn_t fn)
864 struct ndr_pull *ndr;
865 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
866 NDR_ERR_HAVE_NO_MEMORY(ndr);
867 NDR_CHECK(ndr_pull_set_switch_value(ndr, p, level));
868 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
869 return NDR_ERR_SUCCESS;
873 pull a union from a blob using NDR, given the union discriminator,
874 failing if all bytes are not consumed
876 _PUBLIC_ enum ndr_err_code ndr_pull_union_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
877 struct smb_iconv_convenience *iconv_convenience, void *p,
878 uint32_t level, ndr_pull_flags_fn_t fn)
880 struct ndr_pull *ndr;
881 ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
882 NDR_ERR_HAVE_NO_MEMORY(ndr);
883 NDR_CHECK(ndr_pull_set_switch_value(ndr, p, level));
884 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
885 if (ndr->offset < ndr->data_size) {
886 return ndr_pull_error(ndr, NDR_ERR_UNREAD_BYTES,
887 "not all bytes consumed ofs[%u] size[%u]",
888 ndr->offset, ndr->data_size);
890 return NDR_ERR_SUCCESS;
894 push a struct to a blob using NDR
896 _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)
898 struct ndr_push *ndr;
899 ndr = ndr_push_init_ctx(mem_ctx, iconv_convenience);
900 NDR_ERR_HAVE_NO_MEMORY(ndr);
902 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
904 *blob = ndr_push_blob(ndr);
905 talloc_steal(mem_ctx, blob->data);
908 return NDR_ERR_SUCCESS;
912 push a union to a blob using NDR
914 _PUBLIC_ enum ndr_err_code ndr_push_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, void *p,
915 uint32_t level, ndr_push_flags_fn_t fn)
917 struct ndr_push *ndr;
918 ndr = ndr_push_init_ctx(mem_ctx, iconv_convenience);
919 NDR_ERR_HAVE_NO_MEMORY(ndr);
921 NDR_CHECK(ndr_push_set_switch_value(ndr, p, level));
922 NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
924 *blob = ndr_push_blob(ndr);
925 talloc_steal(mem_ctx, blob->data);
928 return NDR_ERR_SUCCESS;
932 generic ndr_size_*() handler for structures
934 _PUBLIC_ size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push, struct smb_iconv_convenience *iconv_convenience)
936 struct ndr_push *ndr;
937 enum ndr_err_code status;
940 /* avoid recursion */
941 if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
943 ndr = ndr_push_init_ctx(NULL, iconv_convenience);
945 ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
946 status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
947 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
957 generic ndr_size_*() handler for unions
959 _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)
961 struct ndr_push *ndr;
962 enum ndr_err_code status;
965 /* avoid recursion */
966 if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
968 ndr = ndr_push_init_ctx(NULL, iconv_convenience);
970 ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
972 status = ndr_push_set_switch_value(ndr, p, level);
973 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
977 status = push(ndr, NDR_SCALARS|NDR_BUFFERS, p);
978 if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
988 get the current base for relative pointers for the push
990 _PUBLIC_ uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr)
992 return ndr->relative_base_offset;
996 restore the old base for relative pointers for the push
998 _PUBLIC_ void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset)
1000 ndr->relative_base_offset = offset;
1004 setup the current base for relative pointers for the push
1005 called in the NDR_SCALAR stage
1007 _PUBLIC_ enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset)
1009 ndr->relative_base_offset = offset;
1010 return ndr_token_store(ndr, &ndr->relative_base_list, p, offset);
1014 setup the current base for relative pointers for the push
1015 called in the NDR_BUFFERS stage
1017 _PUBLIC_ enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p)
1019 return ndr_token_retrieve(&ndr->relative_base_list, p, &ndr->relative_base_offset);
1023 push a relative object - stage1
1024 this is called during SCALARS processing
1026 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p)
1029 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
1030 return NDR_ERR_SUCCESS;
1032 NDR_CHECK(ndr_push_align(ndr, 4));
1033 NDR_CHECK(ndr_token_store(ndr, &ndr->relative_list, p, ndr->offset));
1034 return ndr_push_uint32(ndr, NDR_SCALARS, 0xFFFFFFFF);
1038 push a relative object - stage2
1039 this is called during buffers processing
1041 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p)
1043 uint32_t save_offset;
1044 uint32_t ptr_offset = 0xFFFFFFFF;
1046 return NDR_ERR_SUCCESS;
1048 save_offset = ndr->offset;
1049 NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ptr_offset));
1050 if (ptr_offset > ndr->offset) {
1051 return ndr_push_error(ndr, NDR_ERR_BUFSIZE,
1052 "ndr_push_relative_ptr2 ptr_offset(%u) > ndr->offset(%u)",
1053 ptr_offset, ndr->offset);
1055 ndr->offset = ptr_offset;
1056 if (save_offset < ndr->relative_base_offset) {
1057 return ndr_push_error(ndr, NDR_ERR_BUFSIZE,
1058 "ndr_push_relative_ptr2 save_offset(%u) < ndr->relative_base_offset(%u)",
1059 save_offset, ndr->relative_base_offset);
1061 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save_offset - ndr->relative_base_offset));
1062 ndr->offset = save_offset;
1063 return NDR_ERR_SUCCESS;
1067 get the current base for relative pointers for the pull
1069 _PUBLIC_ uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr)
1071 return ndr->relative_base_offset;
1075 restore the old base for relative pointers for the pull
1077 _PUBLIC_ void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset)
1079 ndr->relative_base_offset = offset;
1083 setup the current base for relative pointers for the pull
1084 called in the NDR_SCALAR stage
1086 _PUBLIC_ enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset)
1088 ndr->relative_base_offset = offset;
1089 return ndr_token_store(ndr, &ndr->relative_base_list, p, offset);
1093 setup the current base for relative pointers for the pull
1094 called in the NDR_BUFFERS stage
1096 _PUBLIC_ enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p)
1098 return ndr_token_retrieve(&ndr->relative_base_list, p, &ndr->relative_base_offset);
1102 pull a relative object - stage1
1103 called during SCALARS processing
1105 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
1107 rel_offset += ndr->relative_base_offset;
1108 if (rel_offset > ndr->data_size) {
1109 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
1110 "ndr_pull_relative_ptr1 rel_offset(%u) > ndr->data_size(%u)",
1111 rel_offset, ndr->data_size);
1113 return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
1117 pull a relative object - stage2
1118 called during BUFFERS processing
1120 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p)
1122 uint32_t rel_offset;
1123 NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
1124 return ndr_pull_set_offset(ndr, rel_offset);
1127 const static struct {
1128 enum ndr_err_code err;
1130 } ndr_err_code_strings[] = {
1131 { NDR_ERR_SUCCESS, "Success" },
1132 { NDR_ERR_ARRAY_SIZE, "Bad Array Size" },
1133 { NDR_ERR_BAD_SWITCH, "Bad Switch" },
1134 { NDR_ERR_OFFSET, "Offset Error" },
1135 { NDR_ERR_RELATIVE, "Relative Pointer Error" },
1136 { NDR_ERR_CHARCNV, "Character Conversion Error" },
1137 { NDR_ERR_LENGTH, "Length Error" },
1138 { NDR_ERR_SUBCONTEXT, "Subcontext Error" },
1139 { NDR_ERR_COMPRESSION, "Compression Error" },
1140 { NDR_ERR_STRING, "String Error" },
1141 { NDR_ERR_VALIDATE, "Validate Error" },
1142 { NDR_ERR_BUFSIZE, "Buffer Size Error" },
1143 { NDR_ERR_ALLOC, "Allocation Error" },
1144 { NDR_ERR_RANGE, "Range Error" },
1145 { NDR_ERR_TOKEN, "Token Error" },
1146 { NDR_ERR_IPV4ADDRESS, "IPv4 Address Error" },
1147 { NDR_ERR_INVALID_POINTER, "Invalid Pointer" },
1148 { NDR_ERR_UNREAD_BYTES, "Unread Bytes" },
1152 _PUBLIC_ const char *ndr_map_error2string(enum ndr_err_code ndr_err)
1155 for (i = 0; ndr_err_code_strings[i].string != NULL; i++) {
1156 if (ndr_err_code_strings[i].err == ndr_err)
1157 return ndr_err_code_strings[i].string;
1159 return "Unknown error";