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 (*pflags
) |= new_flags
;
374 return and possibly log an NDR error
376 _PUBLIC_
enum ndr_err_code
ndr_pull_error(struct ndr_pull
*ndr
,
377 enum ndr_err_code ndr_err
,
378 const char *format
, ...)
384 va_start(ap
, format
);
385 ret
= vasprintf(&s
, format
, ap
);
389 return NDR_ERR_ALLOC
;
392 DEBUG(1,("ndr_pull_error(%u): %s\n", ndr_err
, s
));
400 return and possibly log an NDR error
402 _PUBLIC_
enum ndr_err_code
ndr_push_error(struct ndr_push
*ndr
,
403 enum ndr_err_code ndr_err
,
404 const char *format
, ...)
410 va_start(ap
, format
);
411 ret
= vasprintf(&s
, format
, ap
);
415 return NDR_ERR_ALLOC
;
418 DEBUG(1,("ndr_push_error(%u): %s\n", ndr_err
, s
));
426 handle subcontext buffers, which in midl land are user-marshalled, but
427 we use magic in pidl to make them easier to cope with
429 _PUBLIC_
enum ndr_err_code
ndr_pull_subcontext_start(struct ndr_pull
*ndr
,
430 struct ndr_pull
**_subndr
,
434 struct ndr_pull
*subndr
;
435 uint32_t r_content_size
;
436 bool force_le
= false;
437 bool force_be
= false;
439 switch (header_size
) {
441 uint32_t content_size
= ndr
->data_size
- ndr
->offset
;
443 content_size
= size_is
;
445 r_content_size
= content_size
;
450 uint16_t content_size
;
451 NDR_CHECK(ndr_pull_uint16(ndr
, NDR_SCALARS
, &content_size
));
452 if (size_is
>= 0 && size_is
!= content_size
) {
453 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
454 (int)size_is
, (int)content_size
);
456 r_content_size
= content_size
;
461 uint32_t content_size
;
462 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &content_size
));
463 if (size_is
>= 0 && size_is
!= content_size
) {
464 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
465 (int)size_is
, (int)content_size
);
467 r_content_size
= content_size
;
472 * Common Type Header for the Serialization Stream
473 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
479 uint32_t content_size
;
483 NDR_CHECK(ndr_pull_uint8(ndr
, NDR_SCALARS
, &version
));
486 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
487 "Bad subcontext (PULL) Common Type Header version %d != 1",
495 NDR_CHECK(ndr_pull_uint8(ndr
, NDR_SCALARS
, &drep
));
498 } else if (drep
== 0x00) {
501 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
502 "Bad subcontext (PULL) Common Type Header invalid drep 0x%02X",
506 /* length of the "Private Header for Constructed Type" */
507 NDR_CHECK(ndr_pull_uint16(ndr
, NDR_SCALARS
, &hdrlen
));
509 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
510 "Bad subcontext (PULL) Common Type Header length %d != 8",
514 /* filler should be ignored */
515 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &filler
));
518 * Private Header for Constructed Type
520 /* length - will be updated latter */
521 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &content_size
));
522 if (size_is
>= 0 && size_is
!= content_size
) {
523 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
524 (int)size_is
, (int)content_size
);
526 /* the content size must be a multiple of 8 */
527 if ((content_size
% 8) != 0) {
528 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
,
529 "Bad subcontext (PULL) size_is(%d) not padded to 8 content_size %d",
530 (int)size_is
, (int)content_size
);
532 r_content_size
= content_size
;
535 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &reserved
));
539 return ndr_pull_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PULL) header_size %d",
543 NDR_PULL_NEED_BYTES(ndr
, r_content_size
);
545 subndr
= talloc_zero(ndr
, struct ndr_pull
);
546 NDR_ERR_HAVE_NO_MEMORY(subndr
);
547 subndr
->flags
= ndr
->flags
& ~LIBNDR_FLAG_NDR64
;
548 subndr
->current_mem_ctx
= ndr
->current_mem_ctx
;
550 subndr
->data
= ndr
->data
+ ndr
->offset
;
552 subndr
->data_size
= r_content_size
;
553 subndr
->iconv_convenience
= talloc_reference(subndr
, ndr
->iconv_convenience
);
556 ndr_set_flags(&ndr
->flags
, LIBNDR_FLAG_LITTLE_ENDIAN
);
557 } else if (force_be
) {
558 ndr_set_flags(&ndr
->flags
, LIBNDR_FLAG_BIGENDIAN
);
562 return NDR_ERR_SUCCESS
;
565 _PUBLIC_
enum ndr_err_code
ndr_pull_subcontext_end(struct ndr_pull
*ndr
,
566 struct ndr_pull
*subndr
,
573 } else if (header_size
> 0) {
574 advance
= subndr
->data_size
;
576 advance
= subndr
->offset
;
578 NDR_CHECK(ndr_pull_advance(ndr
, advance
));
579 return NDR_ERR_SUCCESS
;
582 _PUBLIC_
enum ndr_err_code
ndr_push_subcontext_start(struct ndr_push
*ndr
,
583 struct ndr_push
**_subndr
,
587 struct ndr_push
*subndr
;
589 subndr
= ndr_push_init_ctx(ndr
, ndr
->iconv_convenience
);
590 NDR_ERR_HAVE_NO_MEMORY(subndr
);
591 subndr
->flags
= ndr
->flags
& ~LIBNDR_FLAG_NDR64
;
594 return NDR_ERR_SUCCESS
;
598 push a subcontext header
600 _PUBLIC_
enum ndr_err_code
ndr_push_subcontext_end(struct ndr_push
*ndr
,
601 struct ndr_push
*subndr
,
608 padding_len
= size_is
- subndr
->offset
;
609 if (padding_len
> 0) {
610 NDR_CHECK(ndr_push_zero(subndr
, padding_len
));
611 } else if (padding_len
< 0) {
612 return ndr_push_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
613 (int)subndr
->offset
, (int)size_is
);
617 switch (header_size
) {
622 NDR_CHECK(ndr_push_uint16(ndr
, NDR_SCALARS
, subndr
->offset
));
626 NDR_CHECK(ndr_push_uint3264(ndr
, NDR_SCALARS
, subndr
->offset
));
631 * Common Type Header for the Serialization Stream
632 * See [MS-RPCE] 2.2.6 Type Serialization Version 1
634 padding_len
= NDR_ROUND(subndr
->offset
, 8) - subndr
->offset
;
635 if (padding_len
> 0) {
636 NDR_CHECK(ndr_push_zero(subndr
, padding_len
));
640 NDR_CHECK(ndr_push_uint8(ndr
, NDR_SCALARS
, 1));
646 NDR_CHECK(ndr_push_uint8(ndr
, NDR_SCALARS
, NDR_BE(ndr
)?0x00:0x10));
648 /* length of the "Private Header for Constructed Type" */
649 NDR_CHECK(ndr_push_uint16(ndr
, NDR_SCALARS
, 8));
652 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, 0xCCCCCCCC));
655 * Private Header for Constructed Type
657 /* length - will be updated latter */
658 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, subndr
->offset
));
661 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, 0));
665 return ndr_push_error(ndr
, NDR_ERR_SUBCONTEXT
, "Bad subcontext header size %d",
669 NDR_CHECK(ndr_push_bytes(ndr
, subndr
->data
, subndr
->offset
));
670 return NDR_ERR_SUCCESS
;
674 store a token in the ndr context, for later retrieval
676 _PUBLIC_
enum ndr_err_code
ndr_token_store(TALLOC_CTX
*mem_ctx
,
677 struct ndr_token_list
**list
,
681 struct ndr_token_list
*tok
;
682 tok
= talloc(mem_ctx
, struct ndr_token_list
);
683 NDR_ERR_HAVE_NO_MEMORY(tok
);
686 DLIST_ADD((*list
), tok
);
687 return NDR_ERR_SUCCESS
;
691 retrieve a token from a ndr context, using cmp_fn to match the tokens
693 _PUBLIC_
enum ndr_err_code
ndr_token_retrieve_cmp_fn(struct ndr_token_list
**list
, const void *key
, uint32_t *v
,
694 comparison_fn_t _cmp_fn
, bool _remove_tok
)
696 struct ndr_token_list
*tok
;
697 for (tok
=*list
;tok
;tok
=tok
->next
) {
698 if (_cmp_fn
&& _cmp_fn(tok
->key
,key
)==0) goto found
;
699 else if (!_cmp_fn
&& tok
->key
== key
) goto found
;
701 return NDR_ERR_TOKEN
;
705 DLIST_REMOVE((*list
), tok
);
708 return NDR_ERR_SUCCESS
;
712 retrieve a token from a ndr context
714 _PUBLIC_
enum ndr_err_code
ndr_token_retrieve(struct ndr_token_list
**list
, const void *key
, uint32_t *v
)
716 return ndr_token_retrieve_cmp_fn(list
, key
, v
, NULL
, true);
720 peek at but don't removed a token from a ndr context
722 _PUBLIC_
uint32_t ndr_token_peek(struct ndr_token_list
**list
, const void *key
)
724 enum ndr_err_code status
;
727 status
= ndr_token_retrieve_cmp_fn(list
, key
, &v
, NULL
, false);
728 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
736 pull an array size field and add it to the array_size_list token list
738 _PUBLIC_
enum ndr_err_code
ndr_pull_array_size(struct ndr_pull
*ndr
, const void *p
)
741 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &size
));
742 return ndr_token_store(ndr
, &ndr
->array_size_list
, p
, size
);
746 get the stored array size field
748 _PUBLIC_
uint32_t ndr_get_array_size(struct ndr_pull
*ndr
, const void *p
)
750 return ndr_token_peek(&ndr
->array_size_list
, p
);
754 check the stored array size field
756 _PUBLIC_
enum ndr_err_code
ndr_check_array_size(struct ndr_pull
*ndr
, void *p
, uint32_t size
)
759 stored
= ndr_token_peek(&ndr
->array_size_list
, p
);
760 if (stored
!= size
) {
761 return ndr_pull_error(ndr
, NDR_ERR_ARRAY_SIZE
,
762 "Bad array size - got %u expected %u\n",
765 return NDR_ERR_SUCCESS
;
769 pull an array length field and add it to the array_length_list token list
771 _PUBLIC_
enum ndr_err_code
ndr_pull_array_length(struct ndr_pull
*ndr
, const void *p
)
773 uint32_t length
, offset
;
774 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &offset
));
776 return ndr_pull_error(ndr
, NDR_ERR_ARRAY_SIZE
,
777 "non-zero array offset %u\n", offset
);
779 NDR_CHECK(ndr_pull_uint3264(ndr
, NDR_SCALARS
, &length
));
780 return ndr_token_store(ndr
, &ndr
->array_length_list
, p
, length
);
784 get the stored array length field
786 _PUBLIC_
uint32_t ndr_get_array_length(struct ndr_pull
*ndr
, const void *p
)
788 return ndr_token_peek(&ndr
->array_length_list
, p
);
792 check the stored array length field
794 _PUBLIC_
enum ndr_err_code
ndr_check_array_length(struct ndr_pull
*ndr
, void *p
, uint32_t length
)
797 stored
= ndr_token_peek(&ndr
->array_length_list
, p
);
798 if (stored
!= length
) {
799 return ndr_pull_error(ndr
, NDR_ERR_ARRAY_SIZE
,
800 "Bad array length - got %u expected %u\n",
803 return NDR_ERR_SUCCESS
;
809 _PUBLIC_
enum ndr_err_code
ndr_push_set_switch_value(struct ndr_push
*ndr
, const void *p
, uint32_t val
)
811 return ndr_token_store(ndr
, &ndr
->switch_list
, p
, val
);
814 _PUBLIC_
enum ndr_err_code
ndr_pull_set_switch_value(struct ndr_pull
*ndr
, const void *p
, uint32_t val
)
816 return ndr_token_store(ndr
, &ndr
->switch_list
, p
, val
);
819 _PUBLIC_
enum ndr_err_code
ndr_print_set_switch_value(struct ndr_print
*ndr
, const void *p
, uint32_t val
)
821 return ndr_token_store(ndr
, &ndr
->switch_list
, p
, val
);
825 retrieve a switch value
827 _PUBLIC_
uint32_t ndr_push_get_switch_value(struct ndr_push
*ndr
, const void *p
)
829 return ndr_token_peek(&ndr
->switch_list
, p
);
832 _PUBLIC_
uint32_t ndr_pull_get_switch_value(struct ndr_pull
*ndr
, const void *p
)
834 return ndr_token_peek(&ndr
->switch_list
, p
);
837 _PUBLIC_
uint32_t ndr_print_get_switch_value(struct ndr_print
*ndr
, const void *p
)
839 return ndr_token_peek(&ndr
->switch_list
, p
);
843 pull a struct from a blob using NDR
845 _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
,
846 ndr_pull_flags_fn_t fn
)
848 struct ndr_pull
*ndr
;
849 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
850 NDR_ERR_HAVE_NO_MEMORY(ndr
);
851 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
853 return NDR_ERR_SUCCESS
;
857 pull a struct from a blob using NDR - failing if all bytes are not consumed
859 _PUBLIC_
enum ndr_err_code
ndr_pull_struct_blob_all(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
,
860 struct smb_iconv_convenience
*iconv_convenience
,
861 void *p
, ndr_pull_flags_fn_t fn
)
863 struct ndr_pull
*ndr
;
864 uint32_t highest_ofs
;
865 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
866 NDR_ERR_HAVE_NO_MEMORY(ndr
);
867 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
868 if (ndr
->offset
> ndr
->relative_highest_offset
) {
869 highest_ofs
= ndr
->offset
;
871 highest_ofs
= ndr
->relative_highest_offset
;
873 if (highest_ofs
< ndr
->data_size
) {
874 enum ndr_err_code ret
;
875 ret
= ndr_pull_error(ndr
, NDR_ERR_UNREAD_BYTES
,
876 "not all bytes consumed ofs[%u] size[%u]",
877 highest_ofs
, ndr
->data_size
);
882 return NDR_ERR_SUCCESS
;
886 pull a union from a blob using NDR, given the union discriminator
888 _PUBLIC_
enum ndr_err_code
ndr_pull_union_blob(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
,
889 struct smb_iconv_convenience
*iconv_convenience
, void *p
,
890 uint32_t level
, ndr_pull_flags_fn_t fn
)
892 struct ndr_pull
*ndr
;
893 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
894 NDR_ERR_HAVE_NO_MEMORY(ndr
);
895 NDR_CHECK_FREE(ndr_pull_set_switch_value(ndr
, p
, level
));
896 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
898 return NDR_ERR_SUCCESS
;
902 pull a union from a blob using NDR, given the union discriminator,
903 failing if all bytes are not consumed
905 _PUBLIC_
enum ndr_err_code
ndr_pull_union_blob_all(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
,
906 struct smb_iconv_convenience
*iconv_convenience
, void *p
,
907 uint32_t level
, ndr_pull_flags_fn_t fn
)
909 struct ndr_pull
*ndr
;
910 uint32_t highest_ofs
;
911 ndr
= ndr_pull_init_blob(blob
, mem_ctx
, iconv_convenience
);
912 NDR_ERR_HAVE_NO_MEMORY(ndr
);
913 NDR_CHECK_FREE(ndr_pull_set_switch_value(ndr
, p
, level
));
914 NDR_CHECK_FREE(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
915 if (ndr
->offset
> ndr
->relative_highest_offset
) {
916 highest_ofs
= ndr
->offset
;
918 highest_ofs
= ndr
->relative_highest_offset
;
920 if (highest_ofs
< ndr
->data_size
) {
921 enum ndr_err_code ret
;
922 ret
= ndr_pull_error(ndr
, NDR_ERR_UNREAD_BYTES
,
923 "not all bytes consumed ofs[%u] size[%u]",
924 highest_ofs
, ndr
->data_size
);
929 return NDR_ERR_SUCCESS
;
933 push a struct to a blob using NDR
935 _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
)
937 struct ndr_push
*ndr
;
938 ndr
= ndr_push_init_ctx(mem_ctx
, iconv_convenience
);
939 NDR_ERR_HAVE_NO_MEMORY(ndr
);
941 NDR_CHECK(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
943 *blob
= ndr_push_blob(ndr
);
944 talloc_steal(mem_ctx
, blob
->data
);
947 return NDR_ERR_SUCCESS
;
951 push a union to a blob using NDR
953 _PUBLIC_
enum ndr_err_code
ndr_push_union_blob(DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, struct smb_iconv_convenience
*iconv_convenience
, void *p
,
954 uint32_t level
, ndr_push_flags_fn_t fn
)
956 struct ndr_push
*ndr
;
957 ndr
= ndr_push_init_ctx(mem_ctx
, iconv_convenience
);
958 NDR_ERR_HAVE_NO_MEMORY(ndr
);
960 NDR_CHECK(ndr_push_set_switch_value(ndr
, p
, level
));
961 NDR_CHECK(fn(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
));
963 *blob
= ndr_push_blob(ndr
);
964 talloc_steal(mem_ctx
, blob
->data
);
967 return NDR_ERR_SUCCESS
;
971 generic ndr_size_*() handler for structures
973 _PUBLIC_
size_t ndr_size_struct(const void *p
, int flags
, ndr_push_flags_fn_t push
, struct smb_iconv_convenience
*iconv_convenience
)
975 struct ndr_push
*ndr
;
976 enum ndr_err_code status
;
979 /* avoid recursion */
980 if (flags
& LIBNDR_FLAG_NO_NDR_SIZE
) return 0;
982 ndr
= ndr_push_init_ctx(NULL
, iconv_convenience
);
984 ndr
->flags
|= flags
| LIBNDR_FLAG_NO_NDR_SIZE
;
985 status
= push(ndr
, NDR_SCALARS
|NDR_BUFFERS
, discard_const(p
));
986 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
996 generic ndr_size_*() handler for unions
998 _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
)
1000 struct ndr_push
*ndr
;
1001 enum ndr_err_code status
;
1004 /* avoid recursion */
1005 if (flags
& LIBNDR_FLAG_NO_NDR_SIZE
) return 0;
1007 ndr
= ndr_push_init_ctx(NULL
, iconv_convenience
);
1009 ndr
->flags
|= flags
| LIBNDR_FLAG_NO_NDR_SIZE
;
1011 status
= ndr_push_set_switch_value(ndr
, p
, level
);
1012 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
1016 status
= push(ndr
, NDR_SCALARS
|NDR_BUFFERS
, p
);
1017 if (!NDR_ERR_CODE_IS_SUCCESS(status
)) {
1027 get the current base for relative pointers for the push
1029 _PUBLIC_
uint32_t ndr_push_get_relative_base_offset(struct ndr_push
*ndr
)
1031 return ndr
->relative_base_offset
;
1035 restore the old base for relative pointers for the push
1037 _PUBLIC_
void ndr_push_restore_relative_base_offset(struct ndr_push
*ndr
, uint32_t offset
)
1039 ndr
->relative_base_offset
= offset
;
1043 setup the current base for relative pointers for the push
1044 called in the NDR_SCALAR stage
1046 _PUBLIC_
enum ndr_err_code
ndr_push_setup_relative_base_offset1(struct ndr_push
*ndr
, const void *p
, uint32_t offset
)
1048 ndr
->relative_base_offset
= offset
;
1049 return ndr_token_store(ndr
, &ndr
->relative_base_list
, p
, offset
);
1053 setup the current base for relative pointers for the push
1054 called in the NDR_BUFFERS stage
1056 _PUBLIC_
enum ndr_err_code
ndr_push_setup_relative_base_offset2(struct ndr_push
*ndr
, const void *p
)
1058 return ndr_token_retrieve(&ndr
->relative_base_list
, p
, &ndr
->relative_base_offset
);
1062 push a relative object - stage1
1063 this is called during SCALARS processing
1065 _PUBLIC_
enum ndr_err_code
ndr_push_relative_ptr1(struct ndr_push
*ndr
, const void *p
)
1068 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, 0));
1069 return NDR_ERR_SUCCESS
;
1071 NDR_CHECK(ndr_push_align(ndr
, 4));
1072 NDR_CHECK(ndr_token_store(ndr
, &ndr
->relative_list
, p
, ndr
->offset
));
1073 return ndr_push_uint32(ndr
, NDR_SCALARS
, 0xFFFFFFFF);
1077 push a short relative object - stage1
1078 this is called during SCALARS processing
1080 _PUBLIC_
enum ndr_err_code
ndr_push_short_relative_ptr1(struct ndr_push
*ndr
, const void *p
)
1083 NDR_CHECK(ndr_push_uint16(ndr
, NDR_SCALARS
, 0));
1084 return NDR_ERR_SUCCESS
;
1086 NDR_CHECK(ndr_push_align(ndr
, 2));
1087 NDR_CHECK(ndr_token_store(ndr
, &ndr
->relative_list
, p
, ndr
->offset
));
1088 return ndr_push_uint16(ndr
, NDR_SCALARS
, 0xFFFF);
1091 push a relative object - stage2
1092 this is called during buffers processing
1094 static enum ndr_err_code
ndr_push_relative_ptr2(struct ndr_push
*ndr
, const void *p
)
1096 uint32_t save_offset
;
1097 uint32_t ptr_offset
= 0xFFFFFFFF;
1099 return NDR_ERR_SUCCESS
;
1101 save_offset
= ndr
->offset
;
1102 NDR_CHECK(ndr_token_retrieve(&ndr
->relative_list
, p
, &ptr_offset
));
1103 if (ptr_offset
> ndr
->offset
) {
1104 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1105 "ndr_push_relative_ptr2 ptr_offset(%u) > ndr->offset(%u)",
1106 ptr_offset
, ndr
->offset
);
1108 ndr
->offset
= ptr_offset
;
1109 if (save_offset
< ndr
->relative_base_offset
) {
1110 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1111 "ndr_push_relative_ptr2 save_offset(%u) < ndr->relative_base_offset(%u)",
1112 save_offset
, ndr
->relative_base_offset
);
1114 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, save_offset
- ndr
->relative_base_offset
));
1115 ndr
->offset
= save_offset
;
1116 return NDR_ERR_SUCCESS
;
1119 push a short relative object - stage2
1120 this is called during buffers processing
1122 _PUBLIC_
enum ndr_err_code
ndr_push_short_relative_ptr2(struct ndr_push
*ndr
, const void *p
)
1124 uint32_t save_offset
;
1125 uint32_t ptr_offset
= 0xFFFF;
1127 return NDR_ERR_SUCCESS
;
1129 save_offset
= ndr
->offset
;
1130 NDR_CHECK(ndr_token_retrieve(&ndr
->relative_list
, p
, &ptr_offset
));
1131 if (ptr_offset
> ndr
->offset
) {
1132 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1133 "ndr_push_short_relative_ptr2 ptr_offset(%u) > ndr->offset(%u)",
1134 ptr_offset
, ndr
->offset
);
1136 ndr
->offset
= ptr_offset
;
1137 if (save_offset
< ndr
->relative_base_offset
) {
1138 return ndr_push_error(ndr
, NDR_ERR_BUFSIZE
,
1139 "ndr_push_relative_ptr2 save_offset(%u) < ndr->relative_base_offset(%u)",
1140 save_offset
, ndr
->relative_base_offset
);
1142 NDR_CHECK(ndr_push_uint16(ndr
, NDR_SCALARS
, save_offset
- ndr
->relative_base_offset
));
1143 ndr
->offset
= save_offset
;
1144 return NDR_ERR_SUCCESS
;
1148 push a relative object - stage2 start
1149 this is called during buffers processing
1151 _PUBLIC_
enum ndr_err_code
ndr_push_relative_ptr2_start(struct ndr_push
*ndr
, const void *p
)
1154 return NDR_ERR_SUCCESS
;
1156 return ndr_push_relative_ptr2(ndr
, p
);
1160 push a relative object - stage2 end
1161 this is called during buffers processing
1163 _PUBLIC_
enum ndr_err_code
ndr_push_relative_ptr2_end(struct ndr_push
*ndr
, const void *p
)
1166 return NDR_ERR_SUCCESS
;
1168 return NDR_ERR_SUCCESS
;
1172 get the current base for relative pointers for the pull
1174 _PUBLIC_
uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull
*ndr
)
1176 return ndr
->relative_base_offset
;
1180 restore the old base for relative pointers for the pull
1182 _PUBLIC_
void ndr_pull_restore_relative_base_offset(struct ndr_pull
*ndr
, uint32_t offset
)
1184 ndr
->relative_base_offset
= offset
;
1188 setup the current base for relative pointers for the pull
1189 called in the NDR_SCALAR stage
1191 _PUBLIC_
enum ndr_err_code
ndr_pull_setup_relative_base_offset1(struct ndr_pull
*ndr
, const void *p
, uint32_t offset
)
1193 ndr
->relative_base_offset
= offset
;
1194 return ndr_token_store(ndr
, &ndr
->relative_base_list
, p
, offset
);
1198 setup the current base for relative pointers for the pull
1199 called in the NDR_BUFFERS stage
1201 _PUBLIC_
enum ndr_err_code
ndr_pull_setup_relative_base_offset2(struct ndr_pull
*ndr
, const void *p
)
1203 return ndr_token_retrieve(&ndr
->relative_base_list
, p
, &ndr
->relative_base_offset
);
1207 pull a relative object - stage1
1208 called during SCALARS processing
1210 _PUBLIC_
enum ndr_err_code
ndr_pull_relative_ptr1(struct ndr_pull
*ndr
, const void *p
, uint32_t rel_offset
)
1212 rel_offset
+= ndr
->relative_base_offset
;
1213 if (rel_offset
> ndr
->data_size
) {
1214 return ndr_pull_error(ndr
, NDR_ERR_BUFSIZE
,
1215 "ndr_pull_relative_ptr1 rel_offset(%u) > ndr->data_size(%u)",
1216 rel_offset
, ndr
->data_size
);
1218 return ndr_token_store(ndr
, &ndr
->relative_list
, p
, rel_offset
);
1222 pull a relative object - stage2
1223 called during BUFFERS processing
1225 _PUBLIC_
enum ndr_err_code
ndr_pull_relative_ptr2(struct ndr_pull
*ndr
, const void *p
)
1227 uint32_t rel_offset
;
1228 NDR_CHECK(ndr_token_retrieve(&ndr
->relative_list
, p
, &rel_offset
));
1229 return ndr_pull_set_offset(ndr
, rel_offset
);
1232 const static struct {
1233 enum ndr_err_code err
;
1235 } ndr_err_code_strings
[] = {
1236 { NDR_ERR_SUCCESS
, "Success" },
1237 { NDR_ERR_ARRAY_SIZE
, "Bad Array Size" },
1238 { NDR_ERR_BAD_SWITCH
, "Bad Switch" },
1239 { NDR_ERR_OFFSET
, "Offset Error" },
1240 { NDR_ERR_RELATIVE
, "Relative Pointer Error" },
1241 { NDR_ERR_CHARCNV
, "Character Conversion Error" },
1242 { NDR_ERR_LENGTH
, "Length Error" },
1243 { NDR_ERR_SUBCONTEXT
, "Subcontext Error" },
1244 { NDR_ERR_COMPRESSION
, "Compression Error" },
1245 { NDR_ERR_STRING
, "String Error" },
1246 { NDR_ERR_VALIDATE
, "Validate Error" },
1247 { NDR_ERR_BUFSIZE
, "Buffer Size Error" },
1248 { NDR_ERR_ALLOC
, "Allocation Error" },
1249 { NDR_ERR_RANGE
, "Range Error" },
1250 { NDR_ERR_TOKEN
, "Token Error" },
1251 { NDR_ERR_IPV4ADDRESS
, "IPv4 Address Error" },
1252 { NDR_ERR_INVALID_POINTER
, "Invalid Pointer" },
1253 { NDR_ERR_UNREAD_BYTES
, "Unread Bytes" },
1254 { NDR_ERR_NDR64
, "NDR64 assertion error" },
1258 _PUBLIC_
const char *ndr_map_error2string(enum ndr_err_code ndr_err
)
1261 for (i
= 0; ndr_err_code_strings
[i
].string
!= NULL
; i
++) {
1262 if (ndr_err_code_strings
[i
].err
== ndr_err
)
1263 return ndr_err_code_strings
[i
].string
;
1265 return "Unknown error";