2 Unix SMB/CIFS implementation.
3 rpc interface definitions
5 Copyright (C) Andrew Tridgell 2003
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 /* This is a public header file that is installed as part of Samba.
22 * If you remove any functions or change their signature, update
23 * the so version number. */
30 #include "../lib/util/samba_util.h" /* for discard_const */
31 #include "../lib/util/charset/charset.h"
34 this provides definitions for the libcli/rpc/ MSRPC library
39 this is used by the token store/retrieve code
41 struct ndr_token_list
{
42 struct ndr_token_list
*next
, *prev
;
47 /* this is the base structure passed to routines that
48 parse MSRPC formatted data
50 note that in Samba4 we use separate routines and structures for
51 MSRPC marshalling and unmarshalling. Also note that these routines
52 are being kept deliberately very simple, and are not tied to a
56 uint32_t flags
; /* LIBNDR_FLAG_* */
61 uint32_t relative_highest_offset
;
62 uint32_t relative_base_offset
;
63 uint32_t relative_rap_convert
;
64 struct ndr_token_list
*relative_base_list
;
66 struct ndr_token_list
*relative_list
;
67 struct ndr_token_list
*array_size_list
;
68 struct ndr_token_list
*array_length_list
;
69 struct ndr_token_list
*switch_list
;
71 TALLOC_CTX
*current_mem_ctx
;
73 /* this is used to ensure we generate unique reference IDs
74 between request and reply */
78 /* structure passed to functions that generate NDR formatted data */
80 uint32_t flags
; /* LIBNDR_FLAG_* */
85 uint32_t relative_base_offset
;
86 uint32_t relative_end_offset
;
87 struct ndr_token_list
*relative_base_list
;
89 struct ndr_token_list
*switch_list
;
90 struct ndr_token_list
*relative_list
;
91 struct ndr_token_list
*relative_begin_list
;
92 struct ndr_token_list
*nbt_string_list
;
93 struct ndr_token_list
*dns_string_list
;
94 struct ndr_token_list
*full_ptr_list
;
96 /* this is used to ensure we generate unique reference IDs */
100 /* structure passed to functions that print IDL structures */
102 uint32_t flags
; /* LIBNDR_FLAG_* */
104 struct ndr_token_list
*switch_list
;
105 void (*print
)(struct ndr_print
*, const char *, ...) PRINTF_ATTRIBUTE(2,3);
110 #define LIBNDR_FLAG_BIGENDIAN (1<<0)
111 #define LIBNDR_FLAG_NOALIGN (1<<1)
113 #define LIBNDR_FLAG_STR_ASCII (1<<2)
114 #define LIBNDR_FLAG_STR_LEN4 (1<<3)
115 #define LIBNDR_FLAG_STR_SIZE4 (1<<4)
116 #define LIBNDR_FLAG_STR_NOTERM (1<<5)
117 #define LIBNDR_FLAG_STR_NULLTERM (1<<6)
118 #define LIBNDR_FLAG_STR_SIZE2 (1<<7)
119 #define LIBNDR_FLAG_STR_BYTESIZE (1<<8)
120 #define LIBNDR_FLAG_STR_CONFORMANT (1<<10)
121 #define LIBNDR_FLAG_STR_CHARLEN (1<<11)
122 #define LIBNDR_FLAG_STR_UTF8 (1<<12)
123 #define LIBNDR_FLAG_STR_RAW8 (1<<13)
124 #define LIBNDR_STRING_FLAGS (0x7FFC)
127 * don't debug NDR_ERR_BUFSIZE failures,
128 * as the available buffer might be incomplete.
130 * return NDR_ERR_INCOMPLETE_BUFFER instead.
132 #define LIBNDR_FLAG_INCOMPLETE_BUFFER (1<<16)
135 * This lets ndr_pull_subcontext_end() return
136 * NDR_ERR_UNREAD_BYTES.
138 #define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1<<17)
140 /* set if relative pointers should *not* be marshalled in reverse order */
141 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1<<18)
143 /* set if relative pointers are marshalled in reverse order */
144 #define LIBNDR_FLAG_RELATIVE_REVERSE (1<<19)
146 #define LIBNDR_FLAG_REF_ALLOC (1<<20)
147 #define LIBNDR_FLAG_REMAINING (1<<21)
148 #define LIBNDR_FLAG_ALIGN2 (1<<22)
149 #define LIBNDR_FLAG_ALIGN4 (1<<23)
150 #define LIBNDR_FLAG_ALIGN8 (1<<24)
152 #define LIBNDR_ALIGN_FLAGS ( 0 | \
153 LIBNDR_FLAG_NOALIGN | \
154 LIBNDR_FLAG_REMAINING | \
155 LIBNDR_FLAG_ALIGN2 | \
156 LIBNDR_FLAG_ALIGN4 | \
157 LIBNDR_FLAG_ALIGN8 | \
160 #define LIBNDR_PRINT_ARRAY_HEX (1<<25)
161 #define LIBNDR_PRINT_SET_VALUES (1<<26)
163 /* used to force a section of IDL to be little-endian */
164 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
166 /* used to check if alignment padding is zero */
167 #define LIBNDR_FLAG_PAD_CHECK (1<<28)
169 #define LIBNDR_FLAG_NDR64 (1<<29)
171 /* set if an object uuid will be present */
172 #define LIBNDR_FLAG_OBJECT_PRESENT (1<<30)
174 /* set to avoid recursion in ndr_size_*() calculation */
175 #define LIBNDR_FLAG_NO_NDR_SIZE (1<<31)
177 /* useful macro for debugging */
178 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
179 #define NDR_PRINT_DEBUGC(dbgc_class, type, p) ndr_print_debugc(dbgc_class, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
180 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
181 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
182 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
183 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
184 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
186 /* useful macro for debugging in strings */
187 #define NDR_PRINT_STRUCT_STRING(ctx, type, p) ndr_print_struct_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
188 #define NDR_PRINT_UNION_STRING(ctx, type, level, p) ndr_print_union_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
189 #define NDR_PRINT_FUNCTION_STRING(ctx, type, flags, p) ndr_print_function_string(ctx, (ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
190 #define NDR_PRINT_BOTH_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_BOTH, p)
191 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
192 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
194 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
214 NDR_ERR_INVALID_POINTER
,
215 NDR_ERR_UNREAD_BYTES
,
218 NDR_ERR_INCOMPLETE_BUFFER
221 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
223 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
225 return NDR_ERR_ALLOC; \
229 enum ndr_compression_alg
{
230 NDR_COMPRESSION_MSZIP
= 2,
231 NDR_COMPRESSION_XPRESS
= 3
235 flags passed to control parse flow
236 These are deliberately in a different range to the NDR_IN/NDR_OUT
237 flags to catch mixups
239 #define NDR_SCALARS 0x100
240 #define NDR_BUFFERS 0x200
243 flags passed to ndr_print_*() and ndr pull/push for functions
244 These are deliberately in a different range to the NDR_SCALARS/NDR_BUFFERS
245 flags to catch mixups
249 #define NDR_BOTH 0x30
250 #define NDR_SET_VALUES 0x40
253 #define NDR_PULL_CHECK_FLAGS(ndr, ndr_flags) do { \
254 if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) { \
255 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid pull struct ndr_flags 0x%x", ndr_flags); \
259 #define NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags) do { \
260 if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) \
261 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid push struct ndr_flags 0x%x", ndr_flags); \
264 #define NDR_PULL_CHECK_FN_FLAGS(ndr, flags) do { \
265 if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) { \
266 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid fn pull flags 0x%x", flags); \
270 #define NDR_PUSH_CHECK_FN_FLAGS(ndr, flags) do { \
271 if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) \
272 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid fn push flags 0x%x", flags); \
275 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
276 if (unlikely((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size)) { \
277 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
278 uint32_t _available = ndr->data_size - ndr->offset; \
279 uint32_t _missing = n - _available; \
280 ndr->relative_highest_offset = _missing; \
282 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
286 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
288 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
290 #define NDR_PULL_ALIGN(ndr, n) do { \
291 if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) { \
292 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) { \
293 ndr_check_padding(ndr, n); \
295 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
297 if (unlikely(ndr->offset > ndr->data_size)) { \
298 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
299 uint32_t _missing = ndr->offset - ndr->data_size; \
300 ndr->relative_highest_offset = _missing; \
302 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
306 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
308 #define NDR_PUSH_ALIGN(ndr, n) do { \
309 if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) { \
310 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
311 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
315 /* these are used to make the error checking on each element in libndr
316 less tedious, hopefully making the code more readable */
317 #define NDR_CHECK(call) do { \
318 enum ndr_err_code _status; \
320 if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) { \
325 /* if the call fails then free the ndr pointer */
326 #define NDR_CHECK_FREE(call) do { \
327 enum ndr_err_code _status; \
329 if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) { \
335 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
337 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
338 if ( !(flgs) || (ndr->flags & flgs) ) {\
340 return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
342 ndr->current_mem_ctx = discard_const(mem_ctx);\
346 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
347 if (!ndr->current_mem_ctx) {\
348 ndr->current_mem_ctx = talloc_new(ndr);\
349 if (!ndr->current_mem_ctx) {\
350 return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
355 #define NDR_PULL_ALLOC(ndr, s) do { \
356 _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
357 (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
358 if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
361 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
362 _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
363 (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
364 if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
368 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
369 (s) = talloc_array(ndr, uint8_t, size); \
370 if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
373 #define NDR_PUSH_ALLOC(ndr, s) do { \
374 (s) = talloc_ptrtype(ndr, (s)); \
375 if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
378 /* these are used when generic fn pointers are needed for ndr push/pull fns */
379 typedef enum ndr_err_code (*ndr_push_flags_fn_t
)(struct ndr_push
*, int ndr_flags
, const void *);
380 typedef enum ndr_err_code (*ndr_pull_flags_fn_t
)(struct ndr_pull
*, int ndr_flags
, void *);
381 typedef void (*ndr_print_fn_t
)(struct ndr_print
*, const char *, const void *);
382 typedef void (*ndr_print_function_t
)(struct ndr_print
*, const char *, int, const void *);
384 #include "../libcli/util/error.h"
385 #include "librpc/gen_ndr/misc.h"
387 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr
;
388 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr64
;
389 extern const struct ndr_syntax_id ndr_syntax_id_null
;
391 struct ndr_interface_call_pipe
{
393 const char *chunk_struct_name
;
394 size_t chunk_struct_size
;
395 ndr_push_flags_fn_t ndr_push
;
396 ndr_pull_flags_fn_t ndr_pull
;
397 ndr_print_fn_t ndr_print
;
400 struct ndr_interface_call_pipes
{
402 const struct ndr_interface_call_pipe
*pipes
;
405 struct ndr_interface_call
{
408 ndr_push_flags_fn_t ndr_push
;
409 ndr_pull_flags_fn_t ndr_pull
;
410 ndr_print_function_t ndr_print
;
411 struct ndr_interface_call_pipes in_pipes
;
412 struct ndr_interface_call_pipes out_pipes
;
415 struct ndr_interface_string_array
{
417 const char * const *names
;
420 struct ndr_interface_table
{
422 struct ndr_syntax_id syntax_id
;
423 const char *helpstring
;
425 const struct ndr_interface_call
*calls
;
426 const struct ndr_interface_string_array
*endpoints
;
427 const struct ndr_interface_string_array
*authservices
;
430 struct ndr_interface_list
{
431 struct ndr_interface_list
*prev
, *next
;
432 const struct ndr_interface_table
*table
;
435 struct sockaddr_storage
;
437 /*********************************************************************
438 Map an NT error code from a NDR error code.
439 *********************************************************************/
440 NTSTATUS
ndr_map_error2ntstatus(enum ndr_err_code ndr_err
);
441 int ndr_map_error2errno(enum ndr_err_code ndr_err
);
442 const char *ndr_map_error2string(enum ndr_err_code ndr_err
);
443 #define ndr_errstr ndr_map_error2string
445 /* FIXME: Use represent_as instead */
447 enum ndr_err_code
ndr_push_dom_sid2(struct ndr_push
*ndr
, int ndr_flags
, const struct dom_sid
*sid
);
448 enum ndr_err_code
ndr_pull_dom_sid2(struct ndr_pull
*ndr
, int ndr_flags
, struct dom_sid
*sid
);
449 void ndr_print_dom_sid2(struct ndr_print
*ndr
, const char *name
, const struct dom_sid
*sid
);
450 enum ndr_err_code
ndr_push_dom_sid28(struct ndr_push
*ndr
, int ndr_flags
, const struct dom_sid
*sid
);
451 enum ndr_err_code
ndr_pull_dom_sid28(struct ndr_pull
*ndr
, int ndr_flags
, struct dom_sid
*sid
);
452 void ndr_print_dom_sid28(struct ndr_print
*ndr
, const char *name
, const struct dom_sid
*sid
);
453 size_t ndr_size_dom_sid28(const struct dom_sid
*sid
, int flags
);
454 enum ndr_err_code
ndr_push_dom_sid0(struct ndr_push
*ndr
, int ndr_flags
, const struct dom_sid
*sid
);
455 enum ndr_err_code
ndr_pull_dom_sid0(struct ndr_pull
*ndr
, int ndr_flags
, struct dom_sid
*sid
);
456 void ndr_print_dom_sid0(struct ndr_print
*ndr
, const char *name
, const struct dom_sid
*sid
);
457 size_t ndr_size_dom_sid0(const struct dom_sid
*sid
, int flags
);
458 void ndr_print_GUID(struct ndr_print
*ndr
, const char *name
, const struct GUID
*guid
);
459 void ndr_print_sockaddr_storage(struct ndr_print
*ndr
, const char *name
, const struct sockaddr_storage
*ss
);
460 bool ndr_syntax_id_equal(const struct ndr_syntax_id
*i1
, const struct ndr_syntax_id
*i2
);
461 char *ndr_syntax_id_to_string(TALLOC_CTX
*mem_ctx
, const struct ndr_syntax_id
*id
);
462 bool ndr_syntax_id_from_string(const char *s
, struct ndr_syntax_id
*id
);
463 enum ndr_err_code
ndr_push_struct_blob(DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, const void *p
, ndr_push_flags_fn_t fn
);
464 enum ndr_err_code
ndr_push_union_blob(DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, void *p
, uint32_t level
, ndr_push_flags_fn_t fn
);
465 size_t ndr_size_struct(const void *p
, int flags
, ndr_push_flags_fn_t push
);
466 size_t ndr_size_union(const void *p
, int flags
, uint32_t level
, ndr_push_flags_fn_t push
);
467 uint32_t ndr_push_get_relative_base_offset(struct ndr_push
*ndr
);
468 void ndr_push_restore_relative_base_offset(struct ndr_push
*ndr
, uint32_t offset
);
469 enum ndr_err_code
ndr_push_setup_relative_base_offset1(struct ndr_push
*ndr
, const void *p
, uint32_t offset
);
470 enum ndr_err_code
ndr_push_setup_relative_base_offset2(struct ndr_push
*ndr
, const void *p
);
471 enum ndr_err_code
ndr_push_relative_ptr1(struct ndr_push
*ndr
, const void *p
);
472 enum ndr_err_code
ndr_push_short_relative_ptr1(struct ndr_push
*ndr
, const void *p
);
473 enum ndr_err_code
ndr_push_relative_ptr2_start(struct ndr_push
*ndr
, const void *p
);
474 enum ndr_err_code
ndr_push_relative_ptr2_end(struct ndr_push
*ndr
, const void *p
);
475 enum ndr_err_code
ndr_push_short_relative_ptr2(struct ndr_push
*ndr
, const void *p
);
476 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull
*ndr
);
477 void ndr_pull_restore_relative_base_offset(struct ndr_pull
*ndr
, uint32_t offset
);
478 enum ndr_err_code
ndr_pull_setup_relative_base_offset1(struct ndr_pull
*ndr
, const void *p
, uint32_t offset
);
479 enum ndr_err_code
ndr_pull_setup_relative_base_offset2(struct ndr_pull
*ndr
, const void *p
);
480 enum ndr_err_code
ndr_pull_relative_ptr1(struct ndr_pull
*ndr
, const void *p
, uint32_t rel_offset
);
481 enum ndr_err_code
ndr_pull_relative_ptr2(struct ndr_pull
*ndr
, const void *p
);
482 enum ndr_err_code
ndr_pull_relative_ptr_short(struct ndr_pull
*ndr
, uint16_t *v
);
483 size_t ndr_align_size(uint32_t offset
, size_t n
);
484 struct ndr_pull
*ndr_pull_init_blob(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
);
485 enum ndr_err_code
ndr_pull_append(struct ndr_pull
*ndr
, DATA_BLOB
*blob
);
486 enum ndr_err_code
ndr_pull_pop(struct ndr_pull
*ndr
);
487 enum ndr_err_code
ndr_pull_advance(struct ndr_pull
*ndr
, uint32_t size
);
488 struct ndr_push
*ndr_push_init_ctx(TALLOC_CTX
*mem_ctx
);
489 DATA_BLOB
ndr_push_blob(struct ndr_push
*ndr
);
490 enum ndr_err_code
ndr_push_expand(struct ndr_push
*ndr
, uint32_t extra_size
);
491 void ndr_print_debug_helper(struct ndr_print
*ndr
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
492 void ndr_print_debugc_helper(struct ndr_print
*ndr
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
493 void ndr_print_printf_helper(struct ndr_print
*ndr
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
494 void ndr_print_string_helper(struct ndr_print
*ndr
, const char *format
, ...) PRINTF_ATTRIBUTE(2,3);
495 void ndr_print_debug(ndr_print_fn_t fn
, const char *name
, void *ptr
);
496 void ndr_print_debugc(int dbgc_class
, ndr_print_fn_t fn
, const char *name
, void *ptr
);
497 void ndr_print_union_debug(ndr_print_fn_t fn
, const char *name
, uint32_t level
, void *ptr
);
498 void ndr_print_function_debug(ndr_print_function_t fn
, const char *name
, int flags
, void *ptr
);
499 char *ndr_print_struct_string(TALLOC_CTX
*mem_ctx
, ndr_print_fn_t fn
, const char *name
, void *ptr
);
500 char *ndr_print_union_string(TALLOC_CTX
*mem_ctx
, ndr_print_fn_t fn
, const char *name
, uint32_t level
, void *ptr
);
501 char *ndr_print_function_string(TALLOC_CTX
*mem_ctx
,
502 ndr_print_function_t fn
, const char *name
,
503 int flags
, void *ptr
);
504 void ndr_set_flags(uint32_t *pflags
, uint32_t new_flags
);
505 enum ndr_err_code
ndr_pull_error(struct ndr_pull
*ndr
,
506 enum ndr_err_code ndr_err
,
507 const char *format
, ...) PRINTF_ATTRIBUTE(3,4);
508 enum ndr_err_code
ndr_push_error(struct ndr_push
*ndr
,
509 enum ndr_err_code ndr_err
,
510 const char *format
, ...) PRINTF_ATTRIBUTE(3,4);
511 enum ndr_err_code
ndr_pull_subcontext_start(struct ndr_pull
*ndr
,
512 struct ndr_pull
**_subndr
,
515 enum ndr_err_code
ndr_pull_subcontext_end(struct ndr_pull
*ndr
,
516 struct ndr_pull
*subndr
,
519 enum ndr_err_code
ndr_push_subcontext_start(struct ndr_push
*ndr
,
520 struct ndr_push
**_subndr
,
523 enum ndr_err_code
ndr_push_subcontext_end(struct ndr_push
*ndr
,
524 struct ndr_push
*subndr
,
527 enum ndr_err_code
ndr_token_store(TALLOC_CTX
*mem_ctx
,
528 struct ndr_token_list
**list
,
531 enum ndr_err_code
ndr_token_retrieve_cmp_fn(struct ndr_token_list
**list
, const void *key
, uint32_t *v
, int(*_cmp_fn
)(const void*,const void*), bool _remove_tok
);
532 enum ndr_err_code
ndr_token_retrieve(struct ndr_token_list
**list
, const void *key
, uint32_t *v
);
533 uint32_t ndr_token_peek(struct ndr_token_list
**list
, const void *key
);
534 enum ndr_err_code
ndr_pull_array_size(struct ndr_pull
*ndr
, const void *p
);
535 uint32_t ndr_get_array_size(struct ndr_pull
*ndr
, const void *p
);
536 enum ndr_err_code
ndr_check_array_size(struct ndr_pull
*ndr
, void *p
, uint32_t size
);
537 enum ndr_err_code
ndr_pull_array_length(struct ndr_pull
*ndr
, const void *p
);
538 uint32_t ndr_get_array_length(struct ndr_pull
*ndr
, const void *p
);
539 enum ndr_err_code
ndr_check_array_length(struct ndr_pull
*ndr
, void *p
, uint32_t length
);
540 enum ndr_err_code
ndr_push_pipe_chunk_trailer(struct ndr_push
*ndr
, int ndr_flags
, uint32_t count
);
541 enum ndr_err_code
ndr_check_pipe_chunk_trailer(struct ndr_pull
*ndr
, int ndr_flags
, uint32_t count
);
542 enum ndr_err_code
ndr_push_set_switch_value(struct ndr_push
*ndr
, const void *p
, uint32_t val
);
543 enum ndr_err_code
ndr_pull_set_switch_value(struct ndr_pull
*ndr
, const void *p
, uint32_t val
);
544 enum ndr_err_code
ndr_print_set_switch_value(struct ndr_print
*ndr
, const void *p
, uint32_t val
);
545 uint32_t ndr_push_get_switch_value(struct ndr_push
*ndr
, const void *p
);
546 uint32_t ndr_pull_get_switch_value(struct ndr_pull
*ndr
, const void *p
);
547 uint32_t ndr_print_get_switch_value(struct ndr_print
*ndr
, const void *p
);
548 enum ndr_err_code
ndr_pull_struct_blob(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, void *p
, ndr_pull_flags_fn_t fn
);
549 enum ndr_err_code
ndr_pull_struct_blob_all(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, void *p
, ndr_pull_flags_fn_t fn
);
550 enum ndr_err_code
ndr_pull_union_blob(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, void *p
, uint32_t level
, ndr_pull_flags_fn_t fn
);
551 enum ndr_err_code
ndr_pull_union_blob_all(const DATA_BLOB
*blob
, TALLOC_CTX
*mem_ctx
, void *p
, uint32_t level
, ndr_pull_flags_fn_t fn
);
553 /* from libndr_basic.h */
554 #define NDR_SCALAR_PROTO(name, type) \
555 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
556 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
557 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
559 #define NDR_SCALAR_PTR_PROTO(name, type) \
560 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
561 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type **v); \
562 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
564 #define NDR_BUFFER_PROTO(name, type) \
565 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
566 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
567 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
569 NDR_SCALAR_PROTO(uint8
, uint8_t)
570 NDR_SCALAR_PROTO(int8
, int8_t)
571 NDR_SCALAR_PROTO(uint16
, uint16_t)
572 NDR_SCALAR_PROTO(int16
, int16_t)
573 NDR_SCALAR_PROTO(uint1632
, uint16_t)
574 NDR_SCALAR_PROTO(uint32
, uint32_t)
575 NDR_SCALAR_PROTO(uint3264
, uint32_t)
576 NDR_SCALAR_PROTO(int32
, int32_t)
577 NDR_SCALAR_PROTO(int3264
, int32_t)
578 NDR_SCALAR_PROTO(udlong
, uint64_t)
579 NDR_SCALAR_PROTO(udlongr
, uint64_t)
580 NDR_SCALAR_PROTO(dlong
, int64_t)
581 NDR_SCALAR_PROTO(hyper
, uint64_t)
582 NDR_SCALAR_PROTO(pointer
, void *)
583 NDR_SCALAR_PROTO(time_t, time_t)
584 NDR_SCALAR_PROTO(uid_t
, uid_t
)
585 NDR_SCALAR_PROTO(gid_t
, gid_t
)
586 NDR_SCALAR_PROTO(NTSTATUS
, NTSTATUS
)
587 NDR_SCALAR_PROTO(WERROR
, WERROR
)
588 NDR_SCALAR_PROTO(NTTIME
, NTTIME
)
589 NDR_SCALAR_PROTO(NTTIME_1sec
, NTTIME
)
590 NDR_SCALAR_PROTO(NTTIME_hyper
, NTTIME
)
591 NDR_SCALAR_PROTO(DATA_BLOB
, DATA_BLOB
)
592 NDR_SCALAR_PROTO(ipv4address
, const char *)
593 NDR_SCALAR_PROTO(ipv6address
, const char *)
594 NDR_SCALAR_PROTO(string
, const char *)
595 NDR_SCALAR_PROTO(double, double)
597 enum ndr_err_code
ndr_pull_policy_handle(struct ndr_pull
*ndr
, int ndr_flags
, struct policy_handle
*r
);
598 enum ndr_err_code
ndr_push_policy_handle(struct ndr_push
*ndr
, int ndr_flags
, const struct policy_handle
*r
);
599 void ndr_print_policy_handle(struct ndr_print
*ndr
, const char *name
, const struct policy_handle
*r
);
600 bool ndr_policy_handle_empty(const struct policy_handle
*h
);
601 #define is_valid_policy_hnd(hnd) (!ndr_policy_handle_empty(hnd))
602 bool ndr_policy_handle_equal(const struct policy_handle
*hnd1
,
603 const struct policy_handle
*hnd2
);
605 void ndr_check_padding(struct ndr_pull
*ndr
, size_t n
);
606 enum ndr_err_code
ndr_pull_generic_ptr(struct ndr_pull
*ndr
, uint32_t *v
);
607 enum ndr_err_code
ndr_pull_ref_ptr(struct ndr_pull
*ndr
, uint32_t *v
);
608 enum ndr_err_code
ndr_pull_bytes(struct ndr_pull
*ndr
, uint8_t *data
, uint32_t n
);
609 enum ndr_err_code
ndr_pull_array_uint8(struct ndr_pull
*ndr
, int ndr_flags
, uint8_t *data
, uint32_t n
);
610 enum ndr_err_code
ndr_push_align(struct ndr_push
*ndr
, size_t size
);
611 enum ndr_err_code
ndr_pull_align(struct ndr_pull
*ndr
, size_t size
);
612 enum ndr_err_code
ndr_push_union_align(struct ndr_push
*ndr
, size_t size
);
613 enum ndr_err_code
ndr_pull_union_align(struct ndr_pull
*ndr
, size_t size
);
614 enum ndr_err_code
ndr_push_trailer_align(struct ndr_push
*ndr
, size_t size
);
615 enum ndr_err_code
ndr_pull_trailer_align(struct ndr_pull
*ndr
, size_t size
);
616 enum ndr_err_code
ndr_push_bytes(struct ndr_push
*ndr
, const uint8_t *data
, uint32_t n
);
617 enum ndr_err_code
ndr_push_zero(struct ndr_push
*ndr
, uint32_t n
);
618 enum ndr_err_code
ndr_push_array_uint8(struct ndr_push
*ndr
, int ndr_flags
, const uint8_t *data
, uint32_t n
);
619 enum ndr_err_code
ndr_push_unique_ptr(struct ndr_push
*ndr
, const void *p
);
620 enum ndr_err_code
ndr_push_full_ptr(struct ndr_push
*ndr
, const void *p
);
621 enum ndr_err_code
ndr_push_ref_ptr(struct ndr_push
*ndr
);
622 void ndr_print_struct(struct ndr_print
*ndr
, const char *name
, const char *type
);
623 void ndr_print_null(struct ndr_print
*ndr
);
624 void ndr_print_enum(struct ndr_print
*ndr
, const char *name
, const char *type
, const char *val
, uint32_t value
);
625 void ndr_print_bitmap_flag(struct ndr_print
*ndr
, size_t size
, const char *flag_name
, uint32_t flag
, uint32_t value
);
626 void ndr_print_bitmap_flag(struct ndr_print
*ndr
, size_t size
, const char *flag_name
, uint32_t flag
, uint32_t value
);
627 void ndr_print_ptr(struct ndr_print
*ndr
, const char *name
, const void *p
);
628 void ndr_print_union(struct ndr_print
*ndr
, const char *name
, int level
, const char *type
);
629 void ndr_print_bad_level(struct ndr_print
*ndr
, const char *name
, uint16_t level
);
630 void ndr_print_array_uint8(struct ndr_print
*ndr
, const char *name
, const uint8_t *data
, uint32_t count
);
631 uint32_t ndr_size_DATA_BLOB(int ret
, const DATA_BLOB
*data
, int flags
);
634 uint32_t ndr_charset_length(const void *var
, charset_t chset
);
635 size_t ndr_string_array_size(struct ndr_push
*ndr
, const char *s
);
636 uint32_t ndr_size_string(int ret
, const char * const* string
, int flags
);
637 enum ndr_err_code
ndr_pull_string_array(struct ndr_pull
*ndr
, int ndr_flags
, const char ***_a
);
638 enum ndr_err_code
ndr_push_string_array(struct ndr_push
*ndr
, int ndr_flags
, const char **a
);
639 void ndr_print_string_array(struct ndr_print
*ndr
, const char *name
, const char **a
);
640 size_t ndr_size_string_array(const char **a
, uint32_t count
, int flags
);
641 uint32_t ndr_string_length(const void *_var
, uint32_t element_size
);
642 enum ndr_err_code
ndr_check_string_terminator(struct ndr_pull
*ndr
, uint32_t count
, uint32_t element_size
);
643 enum ndr_err_code
ndr_pull_charset(struct ndr_pull
*ndr
, int ndr_flags
, const char **var
, uint32_t length
, uint8_t byte_mul
, charset_t chset
);
644 enum ndr_err_code
ndr_pull_charset_to_null(struct ndr_pull
*ndr
, int ndr_flags
, const char **var
, uint32_t length
, uint8_t byte_mul
, charset_t chset
);
645 enum ndr_err_code
ndr_push_charset(struct ndr_push
*ndr
, int ndr_flags
, const char *var
, uint32_t length
, uint8_t byte_mul
, charset_t chset
);
648 bool GUID_equal(const struct GUID
*u1
, const struct GUID
*u2
);
649 NTSTATUS
GUID_to_ndr_blob(const struct GUID
*guid
, TALLOC_CTX
*mem_ctx
, DATA_BLOB
*b
);
650 NTSTATUS
GUID_from_ndr_blob(const DATA_BLOB
*b
, struct GUID
*guid
);
651 NTSTATUS
GUID_from_data_blob(const DATA_BLOB
*s
, struct GUID
*guid
);
652 NTSTATUS
GUID_from_string(const char *s
, struct GUID
*guid
);
653 struct GUID
GUID_zero(void);
654 bool GUID_all_zero(const struct GUID
*u
);
655 int GUID_compare(const struct GUID
*u1
, const struct GUID
*u2
);
656 char *GUID_string(TALLOC_CTX
*mem_ctx
, const struct GUID
*guid
);
657 char *GUID_string2(TALLOC_CTX
*mem_ctx
, const struct GUID
*guid
);
658 char *GUID_hexstring(TALLOC_CTX
*mem_ctx
, const struct GUID
*guid
);
659 struct GUID
GUID_random(void);
661 /* Format is "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x" */
662 /* 32 chars + 4 ' ' + \0 + 2 for adding {} */
663 struct GUID_txt_buf
{ char buf
[39]; };
664 _PUBLIC_
char* GUID_buf_string(const struct GUID
*guid
,
665 struct GUID_txt_buf
*dst
);
667 _PUBLIC_
enum ndr_err_code
ndr_pull_enum_uint8(struct ndr_pull
*ndr
, int ndr_flags
, uint8_t *v
);
668 _PUBLIC_
enum ndr_err_code
ndr_pull_enum_uint16(struct ndr_pull
*ndr
, int ndr_flags
, uint16_t *v
);
669 _PUBLIC_
enum ndr_err_code
ndr_pull_enum_uint32(struct ndr_pull
*ndr
, int ndr_flags
, uint32_t *v
);
670 _PUBLIC_
enum ndr_err_code
ndr_pull_enum_uint1632(struct ndr_pull
*ndr
, int ndr_flags
, uint16_t *v
);
671 _PUBLIC_
enum ndr_err_code
ndr_push_enum_uint8(struct ndr_push
*ndr
, int ndr_flags
, uint8_t v
);
672 _PUBLIC_
enum ndr_err_code
ndr_push_enum_uint16(struct ndr_push
*ndr
, int ndr_flags
, uint16_t v
);
673 _PUBLIC_
enum ndr_err_code
ndr_push_enum_uint32(struct ndr_push
*ndr
, int ndr_flags
, uint32_t v
);
674 _PUBLIC_
enum ndr_err_code
ndr_push_enum_uint1632(struct ndr_push
*ndr
, int ndr_flags
, uint16_t v
);
676 _PUBLIC_
void ndr_print_bool(struct ndr_print
*ndr
, const char *name
, const bool b
);
678 _PUBLIC_
enum ndr_err_code
ndr_push_timespec(struct ndr_push
*ndr
,
680 const struct timespec
*t
);
681 _PUBLIC_
enum ndr_err_code
ndr_pull_timespec(struct ndr_pull
*ndr
,
684 _PUBLIC_
void ndr_print_timespec(struct ndr_print
*ndr
, const char *name
,
685 const struct timespec
*t
);
687 _PUBLIC_
enum ndr_err_code
ndr_push_timeval(struct ndr_push
*ndr
,
689 const struct timeval
*t
);
690 _PUBLIC_
enum ndr_err_code
ndr_pull_timeval(struct ndr_pull
*ndr
,
693 _PUBLIC_
void ndr_print_timeval(struct ndr_print
*ndr
, const char *name
,
694 const struct timeval
*t
);
698 #endif /* __LIBNDR_H__ */