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
;
259 /* this is a s4 hack until we build up the courage to pass
260 * this all the way down
262 #if _SAMBA_BUILD_ == 4
263 ndr
->iconv_convenience
= smb_iconv_convenience_init(talloc_autofree_context(), "ASCII", "UTF-8", true);
266 fn(ndr
, name
, flags
, ptr
);
271 a useful helper function for printing idl structures to a string
273 _PUBLIC_
char *ndr_print_struct_string(TALLOC_CTX
*mem_ctx
, ndr_print_fn_t fn
, const char *name
, void *ptr
)
275 struct ndr_print
*ndr
;
278 ndr
= talloc_zero(mem_ctx
, struct ndr_print
);
279 if (!ndr
) return NULL
;
280 ndr
->private_data
= talloc_strdup(ndr
, "");
281 if (!ndr
->private_data
) {
284 ndr
->print
= ndr_print_string_helper
;
288 /* this is a s4 hack until we build up the courage to pass
289 * this all the way down
291 #if _SAMBA_BUILD_ == 4
292 ndr
->iconv_convenience
= smb_iconv_convenience_init(talloc_autofree_context(), "ASCII", "UTF-8", true);
296 ret
= talloc_steal(mem_ctx
, (char *)ndr
->private_data
);
303 a useful helper function for printing idl unions to a string
305 _PUBLIC_
char *ndr_print_union_string(TALLOC_CTX
*mem_ctx
, ndr_print_fn_t fn
, const char *name
, uint32_t level
, void *ptr
)
307 struct ndr_print
*ndr
;
310 ndr
= talloc_zero(mem_ctx
, struct ndr_print
);
311 if (!ndr
) return NULL
;
312 ndr
->private_data
= talloc_strdup(ndr
, "");
313 if (!ndr
->private_data
) {
316 ndr
->print
= ndr_print_string_helper
;
319 ndr_print_set_switch_value(ndr
, ptr
, level
);
321 ret
= talloc_steal(mem_ctx
, (char *)ndr
->private_data
);
328 a useful helper function for printing idl function calls to a string
330 _PUBLIC_
char *ndr_print_function_string(TALLOC_CTX
*mem_ctx
,
331 ndr_print_function_t fn
, const char *name
,
332 int flags
, void *ptr
)
334 struct ndr_print
*ndr
;
337 ndr
= talloc_zero(mem_ctx
, struct ndr_print
);
338 if (!ndr
) return NULL
;
339 ndr
->private_data
= talloc_strdup(ndr
, "");
340 if (!ndr
->private_data
) {
343 ndr
->print
= ndr_print_string_helper
;
346 fn(ndr
, name
, flags
, ptr
);
347 ret
= talloc_steal(mem_ctx
, (char *)ndr
->private_data
);
353 _PUBLIC_
void ndr_set_flags(uint32_t *pflags
, uint32_t new_flags
)
355 /* the big/little endian flags are inter-dependent */
356 if (new_flags
& LIBNDR_FLAG_LITTLE_ENDIAN
) {
357 (*pflags
) &= ~LIBNDR_FLAG_BIGENDIAN
;
358 (*pflags
) &= ~LIBNDR_FLAG_NDR64
;
360 if (new_flags
& LIBNDR_FLAG_BIGENDIAN
) {
361 (*pflags
) &= ~LIBNDR_FLAG_LITTLE_ENDIAN
;
362 (*pflags
) &= ~LIBNDR_FLAG_NDR64
;
364 if (new_flags
& LIBNDR_FLAG_REMAINING
) {
365 (*pflags
) &= ~LIBNDR_ALIGN_FLAGS
;
367 if (new_flags
& LIBNDR_ALIGN_FLAGS
) {
368 (*pflags
) &= ~LIBNDR_FLAG_REMAINING
;
370 if (new_flags
& LIBNDR_FLAG_NO_RELATIVE_REVERSE
) {
371 (*pflags
) &= ~LIBNDR_FLAG_RELATIVE_REVERSE
;
373 (*pflags
) |= new_flags
;
377 return and possibly log an NDR error
379 _PUBLIC_
enum ndr_err_code
ndr_pull_error(struct ndr_pull
*ndr
,
380 enum ndr_err_code ndr_err
,
381 const char *format
, ...)
387 va_start(ap
, format
);
388 ret
= vasprintf(&s
, format
, ap
);
392 return NDR_ERR_ALLOC
;
395 DEBUG(1,("ndr_pull_error(%u): %s\n", ndr_err
, s
));
403 return and possibly log an NDR error
405 _PUBLIC_
enum ndr_err_code
ndr_push_error(struct ndr_push
*ndr
,
406 enum ndr_err_code ndr_err
,
407 const char *format
, ...)
413 va_start(ap
, format
);
414 ret
= vasprintf(&s
, format
, ap
);
418 return NDR_ERR_ALLOC
;
421 DEBUG(1,("ndr_push_error(%u): %s\n", ndr_err
, s
));
429 handle subcontext buffers, which in midl land are user-marshalled, but
430 we use magic in pidl to make them easier to cope with
432 _PUBLIC_
enum ndr_err_code
ndr_pull_subcontext_start(struct ndr_pull
*ndr
,
433 struct ndr_pull
**_subndr
,
437 struct ndr_pull
*subndr
;
438 uint32_t r_content_size
;
439 bool force_le
= false;
440 bool force_be
= false;
442 switch (header_size
) {
444 uint32_t content_size
= ndr
->data_size
- ndr
->offset
;
446 content_size
= size_is
;
448 r_content_size
= content_size
;
453 uint16_t content_size
;
454 NDR_CHECK(ndr_pull_uint16(ndr
, NDR_SCALARS
, &content_size
));
455 if (size_is
>= 0 && size_is
!= content_size
) {
456 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
457 (int)size_is
, (int)content_size
);
459 r_content_size
= content_size
;
464 uint32_t content_size
;
465 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &content_size
));
466 if (size_is
>= 0 && size_is
!= content_size
) {
467 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
468 (int)size_is
, (int)content_size
);
470 r_content_size
= content_size
;
475 * Common Type Header for the Serialization Stream
476 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
482 uint32_t content_size
;
486 NDR_CHECK(ndr_pull_uint8(ndr
, NDR_SCALARS
, &version
));
489 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
490 "Bad subcontext (PULL) Common Type Header version %d != 1",
498 NDR_CHECK(ndr_pull_uint8(ndr
, NDR_SCALARS
, &drep
));
501 } else if (drep
== 0x00) {
504 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
505 "Bad subcontext (PULL) Common Type Header invalid drep 0x%02X",
509 /* length of the "Private Header for Constructed Type" */
510 NDR_CHECK(ndr_pull_uint16(ndr
, NDR_SCALARS
, &hdrlen
));
512 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
513 "Bad subcontext (PULL) Common Type Header length %d != 8",
517 /* filler should be ignored */
518 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &filler
));
521 * Private Header for Constructed Type
523 /* length - will be updated latter */
524 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &content_size
));
525 if (size_is
>= 0 && size_is
!= content_size
) {
526 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
527 (int)size_is
, (int)content_size
);
529 /* the content size must be a multiple of 8 */
530 if ((content_size
% 8) != 0) {
531 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
532 "Bad subcontext (PULL) size_is(%d) not padded to 8 content_size %d",
533 (int)size_is
, (int)content_size
);
535 r_content_size
= content_size
;
538 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &reserved
));
542 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) header_size %d",
546 NDR_PULL_NEED_BYTES(ndr
, r_content_size
);
548 subndr
= talloc_zero(ndr
, struct ndr_pull
);
549 NDR_ERR_HAVE_NO_MEMORY(subndr
);
550 subndr
->flags
= ndr
->flags
& ~LIBNDR_FLAG_NDR64
;
551 subndr
->current_mem_ctx
= ndr
->current_mem_ctx
;
553 subndr
->data
= ndr
->data
+ ndr
->offset
;
555 subndr
->data_size
= r_content_size
;
556 subndr
->iconv_convenience
= talloc_reference(subndr
, ndr
->iconv_convenience
);
559 ndr_set_flags(&ndr
->flags
, LIBNDR_FLAG_LITTLE_ENDIAN
);
560 } else if (force_be
) {
561 ndr_set_flags(&ndr
->flags
, LIBNDR_FLAG_BIGENDIAN
);
565 return NDR_ERR_SUCCESS
;
568 _PUBLIC_
enum ndr_err_code
ndr_pull_subcontext_end(struct ndr_pull
*ndr
,
569 struct ndr_pull
*subndr
,
576 } else if (header_size
> 0) {
577 advance
= subndr
->data_size
;
579 advance
= subndr
->offset
;
581 NDR_CHECK(ndr_pull_advance(ndr
, advance
));
582 return NDR_ERR_SUCCESS
;
585 _PUBLIC_
enum ndr_err_code
ndr_push_subcontext_start(struct ndr_push
*ndr
,
586 struct ndr_push
**_subndr
,
590 struct ndr_push
*subndr
;
592 subndr
= ndr_push_init_ctx(ndr
, ndr
->iconv_convenience
);
593 NDR_ERR_HAVE_NO_MEMORY(subndr
);
594 subndr
->flags
= ndr
->flags
& ~LIBNDR_FLAG_NDR64
;
597 NDR_CHECK(ndr_push_zero(subndr
, size_is
));
599 subndr
->relative_end_offset
= size_is
;
603 return NDR_ERR_SUCCESS
;
607 push a subcontext header
609 _PUBLIC_
enum ndr_err_code
ndr_push_subcontext_end(struct ndr_push
*ndr
,
610 struct ndr_push
*subndr
,
617 padding_len
= size_is
- subndr
->offset
;
618 if (padding_len
< 0) {
619 return ndr_push_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
620 (int)subndr
->offset
, (int)size_is
);
622 subndr
->offset
= size_is
;
625 switch (header_size
) {
630 NDR_CHECK(ndr_push_uint16(ndr
, NDR_SCALARS
, subndr
->offset
));
634 NDR_CHECK(ndr_push_uint3264(ndr
, NDR_SCALARS
, subndr
->offset
));
639 * Common Type Header for the Serialization Stream
640 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
642 padding_len
= NDR_ROUND(subndr
->offset
, 8) - subndr
->offset
;
643 if (padding_len
> 0) {
644 NDR_CHECK(ndr_push_zero(subndr
, padding_len
));
648 NDR_CHECK(ndr_push_uint8(ndr
, NDR_SCALARS
, 1));
654 NDR_CHECK(ndr_push_uint8(ndr
, NDR_SCALARS
, NDR_BE(ndr
)?0x00:0x10));
656 /* length of the "Private Header for Constructed Type" */
657 NDR_CHECK(ndr_push_uint16(ndr
, NDR_SCALARS
, 8));
660 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, 0xCCCCCCCC));
663 * Private Header for Constructed Type
665 /* length - will be updated latter */
666 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, subndr
->offset
));
669 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, 0));
673 return ndr_push_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext header size %d",
677 NDR_CHECK(ndr_push_bytes(ndr
, subndr
->data
, subndr
->offset
));
678 return NDR_ERR_SUCCESS
;
682 store a token in the ndr context, for later retrieval
684 _PUBLIC_
enum ndr_err_code
ndr_token_store(TALLOC_CTX
*mem_ctx
,
685 struct ndr_token_list
**list
,
689 struct ndr_token_list
*tok
;
690 tok
= talloc(mem_ctx
, struct ndr_token_list
);
691 NDR_ERR_HAVE_NO_MEMORY(tok
);
694 DLIST_ADD((*list
), tok
);
695 return NDR_ERR_SUCCESS
;
699 retrieve a token from a ndr context, using cmp_fn to match the tokens
701 _PUBLIC_
enum ndr_err_code
ndr_token_retrieve_cmp_fn(struct ndr_token_list
**list
, const void *key
, uint32_t *v
,
702 comparison_fn_t _cmp_fn
, bool _remove_tok
)
704 struct ndr_token_list
*tok
;
705 for (tok
=*list
;tok
;tok
=tok
->next
) {
706 if (_cmp_fn
&& _cmp_fn(tok
->key
,key
)==0) goto found
;
707 else if (!_cmp_fn
&& tok
->key
== key
) goto found
;
709 return NDR_ERR_TOKEN
;
713 DLIST_REMOVE((*list
), tok
);
716 return NDR_ERR_SUCCESS
;
720 retrieve a token from a ndr context
722 _PUBLIC_
enum ndr_err_code
ndr_token_retrieve(struct ndr_token_list
**list
, const void *key
, uint32_t *v
)
724 return ndr_token_retrieve_cmp_fn(list
, key
, v
, NULL
, true);
728 peek at but don't removed a token from a ndr context
730 _PUBLIC_
uint32_t ndr_token_peek(struct ndr_token_list
**list
, const void *key
)
732 enum ndr_err_code status
;
735 status
= ndr_token_retrieve_cmp_fn(list
, key
, &v
, NULL
, false);
736 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
744 pull an array size field and add it to the array_size_list token list
746 _PUBLIC_
enum ndr_err_code
ndr_pull_array_size(struct ndr_pull
*ndr
, const void *p
)
749 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &size
));
750 return ndr_token_store(ndr
, &ndr
->array_size_list
, p
, size
);
754 get the stored array size field
756 _PUBLIC_
uint32_t ndr_get_array_size(struct ndr_pull
*ndr
, const void *p
)
758 return ndr_token_peek(&ndr
->array_size_list
, p
);
762 check the stored array size field
764 _PUBLIC_
enum ndr_err_code
ndr_check_array_size(struct ndr_pull
*ndr
, void *p
, uint32_t size
)
767 stored
= ndr_token_peek(&ndr
->array_size_list
, p
);
768 if (stored
!= size
) {
769 return ndr_pull_error(ndr
, NDR_ERR_ARRAY_SIZE
,
770 "Bad array size - got %u expected %u\n",
773 return NDR_ERR_SUCCESS
;
777 pull an array length field and add it to the array_length_list token list
779 _PUBLIC_
enum ndr_err_code
ndr_pull_array_length(struct ndr_pull
*ndr
, const void *p
)
781 uint32_t length
, offset
;
782 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &offset
));
784 return ndr_pull_error(ndr
, NDR_ERR_ARRAY_SIZE
,
785 "non-zero array offset %u\n", offset
);
787 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &length
));
788 return ndr_token_store(ndr
, &ndr
->array_length_list
, p
, length
);
792 get the stored array length field
794 _PUBLIC_
uint32_t ndr_get_array_length(struct ndr_pull
*ndr
, const void *p
)
796 return ndr_token_peek(&ndr
->array_length_list
, p
);
800 check the stored array length field
802 _PUBLIC_
enum ndr_err_code
ndr_check_array_length(struct ndr_pull
*ndr
, void *p
, uint32_t length
)
805 stored
= ndr_token_peek(&ndr
->array_length_list
, p
);
806 if (stored
!= length
) {
807 return ndr_pull_error(ndr
, NDR_ERR_ARRAY_SIZE
,
808 "Bad array length - got %u expected %u\n",
811 return NDR_ERR_SUCCESS
;
817 _PUBLIC_
enum ndr_err_code
ndr_push_set_switch_value(struct ndr_push
*ndr
, const void *p
, uint32_t val
)
819 return ndr_token_store(ndr
, &ndr
->switch_list
, p
, val
);
822 _PUBLIC_
enum ndr_err_code
ndr_pull_set_switch_value(struct ndr_pull
*ndr
, const void *p
, uint32_t val
)
824 return ndr_token_store(ndr
, &ndr
->switch_list
, p
, val
);
827 _PUBLIC_
enum ndr_err_code
ndr_print_set_switch_value(struct ndr_print
*ndr
, const void *p
, uint32_t val
)
829 return ndr_token_store(ndr
, &ndr
->switch_list
, p
, val
);
833 retrieve a switch value
835 _PUBLIC_
uint32_t ndr_push_get_switch_value(struct ndr_push
*ndr
, const void *p
)
837 return ndr_token_peek(&ndr
->switch_list
, p
);
840 _PUBLIC_
uint32_t ndr_pull_get_switch_value(struct ndr_pull
*ndr
, const void *p
)
842 return ndr_token_peek(&ndr
->switch_list
, p
);
845 _PUBLIC_
uint32_t ndr_print_get_switch_value(struct ndr_print
*ndr
, const void *p
)
847 return ndr_token_peek(&ndr
->switch_list
, p
);
851 pull a struct from a blob using NDR
853 _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
,
854 ndr_pull_flags_fn_t fn
)
856 struct ndr_pull
*ndr
;
857 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
858 NDR_ERR_HAVE_NO_MEMORY(ndr
);
859 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
861 return NDR_ERR_SUCCESS
;
865 pull a struct from a blob using NDR - failing if all bytes are not consumed
867 _PUBLIC_
enum ndr_err_code
ndr_pull_struct_blob_all(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
,
868 struct smb_iconv_convenience
*iconv_convenience
,
869 void *p
, ndr_pull_flags_fn_t fn
)
871 struct ndr_pull
*ndr
;
872 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
873 NDR_ERR_HAVE_NO_MEMORY(ndr
);
874 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
875 if (ndr
->offset
< ndr
->data_size
) {
876 return ndr_pull_error(ndr
, NDR_ERR_UNREAD_BYTES
,
877 "not all bytes consumed ofs[%u] size[%u]",
878 ndr
->offset
, ndr
->data_size
);
881 return NDR_ERR_SUCCESS
;
885 pull a union from a blob using NDR, given the union discriminator
887 _PUBLIC_
enum ndr_err_code
ndr_pull_union_blob(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
,
888 struct smb_iconv_convenience
*iconv_convenience
, void *p
,
889 uint32_t level
, ndr_pull_flags_fn_t fn
)
891 struct ndr_pull
*ndr
;
892 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
893 NDR_ERR_HAVE_NO_MEMORY(ndr
);
894 NDR_CHECK_FREE(ndr_pull_set_switch_value(ndr
, p
, level
));
895 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
897 return NDR_ERR_SUCCESS
;
901 pull a union from a blob using NDR, given the union discriminator,
902 failing if all bytes are not consumed
904 _PUBLIC_
enum ndr_err_code
ndr_pull_union_blob_all(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
,
905 struct smb_iconv_convenience
*iconv_convenience
, void *p
,
906 uint32_t level
, ndr_pull_flags_fn_t fn
)
908 struct ndr_pull
*ndr
;
909 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
910 NDR_ERR_HAVE_NO_MEMORY(ndr
);
911 NDR_CHECK_FREE(ndr_pull_set_switch_value(ndr
, p
, level
));
912 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
913 if (ndr
->offset
< ndr
->data_size
) {
914 enum ndr_err_code ret
;
915 ret
= ndr_pull_error(ndr
, NDR_ERR_UNREAD_BYTES
,
916 "not all bytes consumed ofs[%u] size[%u]",
917 ndr
->offset
, ndr
->data_size
);
922 return NDR_ERR_SUCCESS
;
926 push a struct to a blob using NDR
928 _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
)
930 struct ndr_push
*ndr
;
931 ndr
= ndr_push_init_ctx(mem_ctx
, iconv_convenience
);
932 NDR_ERR_HAVE_NO_MEMORY(ndr
);
934 NDR_CHECK(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
936 *blob
= ndr_push_blob(ndr
);
937 talloc_steal(mem_ctx
, blob
->data
);
940 return NDR_ERR_SUCCESS
;
944 push a union to a blob using NDR
946 _PUBLIC_
enum ndr_err_code
ndr_push_union_blob(DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, struct smb_iconv_convenience
*iconv_convenience
, void *p
,
947 uint32_t level
, ndr_push_flags_fn_t fn
)
949 struct ndr_push
*ndr
;
950 ndr
= ndr_push_init_ctx(mem_ctx
, iconv_convenience
);
951 NDR_ERR_HAVE_NO_MEMORY(ndr
);
953 NDR_CHECK(ndr_push_set_switch_value(ndr
, p
, level
));
954 NDR_CHECK(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
956 *blob
= ndr_push_blob(ndr
);
957 talloc_steal(mem_ctx
, blob
->data
);
960 return NDR_ERR_SUCCESS
;
964 generic ndr_size_*() handler for structures
966 _PUBLIC_
size_t ndr_size_struct(const void *p
, int flags
, ndr_push_flags_fn_t push
, struct smb_iconv_convenience
*iconv_convenience
)
968 struct ndr_push
*ndr
;
969 enum ndr_err_code status
;
972 /* avoid recursion */
973 if (flags
& LIBNDR_FLAG_NO_NDR_SIZE
) return 0;
975 ndr
= ndr_push_init_ctx(NULL
, iconv_convenience
);
977 ndr
->flags
|= flags
| LIBNDR_FLAG_NO_NDR_SIZE
;
978 status
= push(ndr
, NDR_SCALARS
|NDR_BUFFERS
, discard_const(p
));
979 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
989 generic ndr_size_*() handler for unions
991 _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
)
993 struct ndr_push
*ndr
;
994 enum ndr_err_code status
;
997 /* avoid recursion */
998 if (flags
& LIBNDR_FLAG_NO_NDR_SIZE
) return 0;
1000 ndr
= ndr_push_init_ctx(NULL
, iconv_convenience
);
1002 ndr
->flags
|= flags
| LIBNDR_FLAG_NO_NDR_SIZE
;
1004 status
= ndr_push_set_switch_value(ndr
, p
, level
);
1005 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
1009 status
= push(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
);
1010 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
1020 get the current base for relative pointers for the push
1022 _PUBLIC_
uint32_t ndr_push_get_relative_base_offset(struct ndr_push
*ndr
)
1024 return ndr
->relative_base_offset
;
1028 restore the old base for relative pointers for the push
1030 _PUBLIC_
void ndr_push_restore_relative_base_offset(struct ndr_push
*ndr
, uint32_t offset
)
1032 ndr
->relative_base_offset
= offset
;
1036 setup the current base for relative pointers for the push
1037 called in the NDR_SCALAR stage
1039 _PUBLIC_
enum ndr_err_code
ndr_push_setup_relative_base_offset1(struct ndr_push
*ndr
, const void *p
, uint32_t offset
)
1041 ndr
->relative_base_offset
= offset
;
1042 return ndr_token_store(ndr
, &ndr
->relative_base_list
, p
, offset
);
1046 setup the current base for relative pointers for the push
1047 called in the NDR_BUFFERS stage
1049 _PUBLIC_
enum ndr_err_code
ndr_push_setup_relative_base_offset2(struct ndr_push
*ndr
, const void *p
)
1051 return ndr_token_retrieve(&ndr
->relative_base_list
, p
, &ndr
->relative_base_offset
);
1055 push a relative object - stage1
1056 this is called during SCALARS processing
1058 _PUBLIC_
enum ndr_err_code
ndr_push_relative_ptr1(struct ndr_push
*ndr
, const void *p
)
1061 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, 0));
1062 return NDR_ERR_SUCCESS
;
1064 NDR_CHECK(ndr_push_align(ndr
, 4));
1065 NDR_CHECK(ndr_token_store(ndr
, &ndr
->relative_list
, p
, ndr
->offset
));
1066 return ndr_push_uint32(ndr
, NDR_SCALARS
, 0xFFFFFFFF);
1070 push a relative object - stage2
1071 this is called during buffers processing
1073 static enum ndr_err_code
ndr_push_relative_ptr2(struct ndr_push
*ndr
, const void *p
)
1075 uint32_t save_offset
;
1076 uint32_t ptr_offset
= 0xFFFFFFFF;
1078 return NDR_ERR_SUCCESS
;
1080 save_offset
= ndr
->offset
;
1081 NDR_CHECK(ndr_token_retrieve(&ndr
->relative_list
, p
, &ptr_offset
));
1082 if (ptr_offset
> ndr
->offset
) {
1083 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1084 "ndr_push_relative_ptr2 ptr_offset(%u) > ndr->offset(%u)",
1085 ptr_offset
, ndr
->offset
);
1087 ndr
->offset
= ptr_offset
;
1088 if (save_offset
< ndr
->relative_base_offset
) {
1089 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1090 "ndr_push_relative_ptr2 save_offset(%u) < ndr->relative_base_offset(%u)",
1091 save_offset
, ndr
->relative_base_offset
);
1093 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, save_offset
- ndr
->relative_base_offset
));
1094 ndr
->offset
= save_offset
;
1095 return NDR_ERR_SUCCESS
;
1099 push a relative object - stage2 start
1100 this is called during buffers processing
1102 _PUBLIC_
enum ndr_err_code
ndr_push_relative_ptr2_start(struct ndr_push
*ndr
, const void *p
)
1105 return NDR_ERR_SUCCESS
;
1107 if (!(ndr
->flags
& LIBNDR_FLAG_RELATIVE_REVERSE
)) {
1108 uint32_t relative_offset
;
1112 if (ndr
->offset
< ndr
->relative_base_offset
) {
1113 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1114 "ndr_push_relative_ptr2_start ndr->offset(%u) < ndr->relative_base_offset(%u)",
1115 ndr
->offset
, ndr
->relative_base_offset
);
1118 relative_offset
= ndr
->offset
- ndr
->relative_base_offset
;
1120 if (ndr
->flags
& LIBNDR_FLAG_ALIGN2
) {
1122 } else if (ndr
->flags
& LIBNDR_FLAG_ALIGN4
) {
1124 } else if (ndr
->flags
& LIBNDR_FLAG_ALIGN8
) {
1128 pad
= ndr_align_size(relative_offset
, align
);
1130 NDR_CHECK(ndr_push_zero(ndr
, pad
));
1133 return ndr_push_relative_ptr2(ndr
, p
);
1135 if (ndr
->relative_end_offset
== -1) {
1136 return ndr_push_error(ndr
, NDR_ERR_RELATIVE
,
1137 "ndr_push_relative_ptr2_start RELATIVE_REVERSE flag set and relative_end_offset %d",
1138 ndr
->relative_end_offset
);
1140 NDR_CHECK(ndr_token_store(ndr
, &ndr
->relative_begin_list
, p
, ndr
->offset
));
1141 return NDR_ERR_SUCCESS
;
1145 push a relative object - stage2 end
1146 this is called during buffers processing
1148 _PUBLIC_
enum ndr_err_code
ndr_push_relative_ptr2_end(struct ndr_push
*ndr
, const void *p
)
1150 uint32_t begin_offset
= 0xFFFFFFFF;
1152 uint32_t correct_offset
= 0;
1157 return NDR_ERR_SUCCESS
;
1160 if (!(ndr
->flags
& LIBNDR_FLAG_RELATIVE_REVERSE
)) {
1161 return NDR_ERR_SUCCESS
;
1164 if (ndr
->flags
& LIBNDR_FLAG_NO_NDR_SIZE
) {
1165 /* better say more than calculation a too small buffer */
1166 NDR_PUSH_ALIGN(ndr
, 8);
1167 return NDR_ERR_SUCCESS
;
1170 if (ndr
->relative_end_offset
< ndr
->offset
) {
1171 return ndr_push_error(ndr
, NDR_ERR_RELATIVE
,
1172 "ndr_push_relative_ptr2_end:"
1173 "relative_end_offset %u < offset %u",
1174 ndr
->relative_end_offset
, ndr
->offset
);
1177 NDR_CHECK(ndr_token_retrieve(&ndr
->relative_begin_list
, p
, &begin_offset
));
1179 /* we have marshalled a buffer, see how long it was */
1180 len
= ndr
->offset
- begin_offset
;
1183 return ndr_push_error(ndr
, NDR_ERR_RELATIVE
,
1184 "ndr_push_relative_ptr2_end:"
1185 "offset %u - begin_offset %u < 0",
1186 ndr
->offset
, begin_offset
);
1189 if (ndr
->relative_end_offset
< len
) {
1190 return ndr_push_error(ndr
, NDR_ERR_RELATIVE
,
1191 "ndr_push_relative_ptr2_end:"
1192 "relative_end_offset %u < len %lld",
1193 ndr
->offset
, (long long)len
);
1196 /* the reversed offset is at the end of the main buffer */
1197 correct_offset
= ndr
->relative_end_offset
- len
;
1199 if (ndr
->flags
& LIBNDR_FLAG_ALIGN2
) {
1201 } else if (ndr
->flags
& LIBNDR_FLAG_ALIGN4
) {
1203 } else if (ndr
->flags
& LIBNDR_FLAG_ALIGN8
) {
1207 pad
= ndr_align_size(correct_offset
, align
);
1209 correct_offset
+= pad
;
1210 correct_offset
-= align
;
1213 if (correct_offset
< begin_offset
) {
1214 return ndr_push_error(ndr
, NDR_ERR_RELATIVE
,
1215 "ndr_push_relative_ptr2_end: "
1216 "correct_offset %u < begin_offset %u",
1217 correct_offset
, begin_offset
);
1221 uint32_t clear_size
= correct_offset
- begin_offset
;
1223 clear_size
= MIN(clear_size
, len
);
1225 /* now move the marshalled buffer to the end of the main buffer */
1226 memmove(ndr
->data
+ correct_offset
, ndr
->data
+ begin_offset
, len
);
1229 /* and wipe out old buffer within the main buffer */
1230 memset(ndr
->data
+ begin_offset
, '\0', clear_size
);
1234 /* and set the end offset for the next buffer */
1235 ndr
->relative_end_offset
= correct_offset
;
1237 /* finally write the offset to the main buffer */
1238 ndr
->offset
= correct_offset
;
1239 NDR_CHECK(ndr_push_relative_ptr2(ndr
, p
));
1241 /* restore to where we were in the main buffer */
1242 ndr
->offset
= begin_offset
;
1244 return NDR_ERR_SUCCESS
;
1248 get the current base for relative pointers for the pull
1250 _PUBLIC_
uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull
*ndr
)
1252 return ndr
->relative_base_offset
;
1256 restore the old base for relative pointers for the pull
1258 _PUBLIC_
void ndr_pull_restore_relative_base_offset(struct ndr_pull
*ndr
, uint32_t offset
)
1260 ndr
->relative_base_offset
= offset
;
1264 setup the current base for relative pointers for the pull
1265 called in the NDR_SCALAR stage
1267 _PUBLIC_
enum ndr_err_code
ndr_pull_setup_relative_base_offset1(struct ndr_pull
*ndr
, const void *p
, uint32_t offset
)
1269 ndr
->relative_base_offset
= offset
;
1270 return ndr_token_store(ndr
, &ndr
->relative_base_list
, p
, offset
);
1274 setup the current base for relative pointers for the pull
1275 called in the NDR_BUFFERS stage
1277 _PUBLIC_
enum ndr_err_code
ndr_pull_setup_relative_base_offset2(struct ndr_pull
*ndr
, const void *p
)
1279 return ndr_token_retrieve(&ndr
->relative_base_list
, p
, &ndr
->relative_base_offset
);
1283 pull a relative object - stage1
1284 called during SCALARS processing
1286 _PUBLIC_
enum ndr_err_code
ndr_pull_relative_ptr1(struct ndr_pull
*ndr
, const void *p
, uint32_t rel_offset
)
1288 rel_offset
+= ndr
->relative_base_offset
;
1289 if (rel_offset
> ndr
->data_size
) {
1290 return ndr_pull_error(ndr
, NDR_ERR_BUFSIZE
,
1291 "ndr_pull_relative_ptr1 rel_offset(%u) > ndr->data_size(%u)",
1292 rel_offset
, ndr
->data_size
);
1294 return ndr_token_store(ndr
, &ndr
->relative_list
, p
, rel_offset
);
1298 pull a relative object - stage2
1299 called during BUFFERS processing
1301 _PUBLIC_
enum ndr_err_code
ndr_pull_relative_ptr2(struct ndr_pull
*ndr
, const void *p
)
1303 uint32_t rel_offset
;
1304 NDR_CHECK(ndr_token_retrieve(&ndr
->relative_list
, p
, &rel_offset
));
1305 return ndr_pull_set_offset(ndr
, rel_offset
);
1308 const static struct {
1309 enum ndr_err_code err
;
1311 } ndr_err_code_strings
[] = {
1312 { NDR_ERR_SUCCESS
, "Success" },
1313 { NDR_ERR_ARRAY_SIZE
, "Bad Array Size" },
1314 { NDR_ERR_BAD_SWITCH
, "Bad Switch" },
1315 { NDR_ERR_OFFSET
, "Offset Error" },
1316 { NDR_ERR_RELATIVE
, "Relative Pointer Error" },
1317 { NDR_ERR_CHARCNV
, "Character Conversion Error" },
1318 { NDR_ERR_LENGTH
, "Length Error" },
1319 { NDR_ERR_SUBCONTEXT
, "Subcontext Error" },
1320 { NDR_ERR_COMPRESSION
, "Compression Error" },
1321 { NDR_ERR_STRING
, "String Error" },
1322 { NDR_ERR_VALIDATE
, "Validate Error" },
1323 { NDR_ERR_BUFSIZE
, "Buffer Size Error" },
1324 { NDR_ERR_ALLOC
, "Allocation Error" },
1325 { NDR_ERR_RANGE
, "Range Error" },
1326 { NDR_ERR_TOKEN
, "Token Error" },
1327 { NDR_ERR_IPV4ADDRESS
, "IPv4 Address Error" },
1328 { NDR_ERR_INVALID_POINTER
, "Invalid Pointer" },
1329 { NDR_ERR_UNREAD_BYTES
, "Unread Bytes" },
1330 { NDR_ERR_NDR64
, "NDR64 assertion error" },
1334 _PUBLIC_
const char *ndr_map_error2string(enum ndr_err_code ndr_err
)
1337 for (i
= 0; ndr_err_code_strings
[i
].string
!= NULL
; i
++) {
1338 if (ndr_err_code_strings
[i
].err
== ndr_err
)
1339 return ndr_err_code_strings
[i
].string
;
1341 return "Unknown error";