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. */
29 #include "../lib/util/discard.h" /* for discard_const */
30 #include "../lib/util/byteorder.h"
31 #include "../lib/util/data_blob.h"
32 #include "../lib/util/time.h"
33 #include "../lib/util/charset/charset.h"
36 this provides definitions for the libcli/rpc/ MSRPC library
41 We store the token mapping in an array that is resized as necessary.
45 struct ndr_token_list {
46 struct ndr_token *tokens;
50 struct ndr_compression_state;
52 /* this is the base structure passed to routines that
53 parse MSRPC formatted data
55 note that in Samba4 we use separate routines and structures for
56 MSRPC marshalling and unmarshalling. Also note that these routines
57 are being kept deliberately very simple, and are not tied to a
61 uint32_t flags; /* LIBNDR_FLAG_* */
66 uint32_t relative_highest_offset;
67 uint32_t relative_base_offset;
68 uint32_t relative_rap_convert;
69 struct ndr_token_list relative_base_list;
71 struct ndr_token_list relative_list;
72 struct ndr_token_list array_size_list;
73 struct ndr_token_list array_length_list;
74 struct ndr_token_list switch_list;
76 struct ndr_compression_state *cstate;
78 TALLOC_CTX *current_mem_ctx;
80 /* this is used to ensure we generate unique reference IDs
81 between request and reply */
85 /* structure passed to functions that generate NDR formatted data */
87 uint32_t flags; /* LIBNDR_FLAG_* */
93 uint32_t relative_base_offset;
94 uint32_t relative_end_offset;
95 struct ndr_token_list relative_base_list;
97 struct ndr_token_list switch_list;
98 struct ndr_token_list relative_list;
99 struct ndr_token_list relative_begin_list;
100 struct ndr_token_list nbt_string_list;
101 struct ndr_token_list dns_string_list;
102 struct ndr_token_list full_ptr_list;
104 struct ndr_compression_state *cstate;
106 /* this is used to ensure we generate unique reference IDs */
110 /* structure passed to functions that print IDL structures */
112 uint32_t flags; /* LIBNDR_FLAG_* */
114 struct ndr_token_list switch_list;
115 void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
121 #define LIBNDR_FLAG_BIGENDIAN (1U<<0)
122 #define LIBNDR_FLAG_NOALIGN (1U<<1)
124 #define LIBNDR_FLAG_STR_ASCII (1U<<2)
125 #define LIBNDR_FLAG_STR_LEN4 (1U<<3)
126 #define LIBNDR_FLAG_STR_SIZE4 (1U<<4)
127 #define LIBNDR_FLAG_STR_NOTERM (1U<<5)
128 #define LIBNDR_FLAG_STR_NULLTERM (1U<<6)
129 #define LIBNDR_FLAG_STR_SIZE2 (1U<<7)
130 #define LIBNDR_FLAG_STR_BYTESIZE (1U<<8)
131 #define LIBNDR_FLAG_STR_CONFORMANT (1U<<10)
132 #define LIBNDR_FLAG_STR_CHARLEN (1U<<11)
133 #define LIBNDR_FLAG_STR_UTF8 (1U<<12)
134 #define LIBNDR_FLAG_STR_RAW8 (1U<<13)
135 #define LIBNDR_STRING_FLAGS (0U | \
136 LIBNDR_FLAG_STR_ASCII | \
137 LIBNDR_FLAG_STR_LEN4 | \
138 LIBNDR_FLAG_STR_SIZE4 | \
139 LIBNDR_FLAG_STR_NOTERM | \
140 LIBNDR_FLAG_STR_NULLTERM | \
141 LIBNDR_FLAG_STR_SIZE2 | \
142 LIBNDR_FLAG_STR_BYTESIZE | \
143 LIBNDR_FLAG_STR_CONFORMANT | \
144 LIBNDR_FLAG_STR_CHARLEN | \
145 LIBNDR_FLAG_STR_UTF8 | \
146 LIBNDR_FLAG_STR_RAW8 | \
150 * Mark an element as SECRET, it won't be printed by
151 * via ndr_print* unless NDR_PRINT_SECRETS is specified.
153 #define LIBNDR_FLAG_IS_SECRET (1U<<14)
155 /* Disable string token compression */
156 #define LIBNDR_FLAG_NO_COMPRESSION (1U<<15)
159 * don't debug NDR_ERR_BUFSIZE failures,
160 * as the available buffer might be incomplete.
162 * return NDR_ERR_INCOMPLETE_BUFFER instead.
164 #define LIBNDR_FLAG_INCOMPLETE_BUFFER (1U<<16)
167 * This lets ndr_pull_subcontext_end() return
168 * NDR_ERR_UNREAD_BYTES.
170 #define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1U<<17)
172 /* set if relative pointers should *not* be marshalled in reverse order */
173 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1U<<18)
175 /* set if relative pointers are marshalled in reverse order */
176 #define LIBNDR_FLAG_RELATIVE_REVERSE (1U<<19)
178 #define LIBNDR_FLAG_REF_ALLOC (1U<<20)
179 #define LIBNDR_FLAG_REMAINING (1U<<21)
180 #define LIBNDR_FLAG_ALIGN2 (1U<<22)
181 #define LIBNDR_FLAG_ALIGN4 (1U<<23)
182 #define LIBNDR_FLAG_ALIGN8 (1U<<24)
184 #define LIBNDR_ALIGN_FLAGS ( 0 | \
185 LIBNDR_FLAG_NOALIGN | \
186 LIBNDR_FLAG_REMAINING | \
187 LIBNDR_FLAG_ALIGN2 | \
188 LIBNDR_FLAG_ALIGN4 | \
189 LIBNDR_FLAG_ALIGN8 | \
192 #define LIBNDR_PRINT_ARRAY_HEX (1U<<25)
193 #define LIBNDR_PRINT_SET_VALUES (1U<<26)
195 /* used to force a section of IDL to be little-endian */
196 #define LIBNDR_FLAG_LITTLE_ENDIAN (1U<<27)
198 /* used to check if alignment padding is zero */
199 #define LIBNDR_FLAG_PAD_CHECK (1U<<28)
201 #define LIBNDR_FLAG_NDR64 (1U<<29)
203 /* set if an object uuid will be present */
204 #define LIBNDR_FLAG_OBJECT_PRESENT (1U<<30)
206 /* set to avoid recursion in ndr_size_*() calculation */
207 #define LIBNDR_FLAG_NO_NDR_SIZE (1U<<31)
209 /* useful macro for debugging */
210 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
211 #define NDR_PRINT_DEBUGC(dbgc_class, type, p) ndr_print_debugc(dbgc_class, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
212 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
213 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
214 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
215 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
216 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
218 /* useful macro for debugging in strings */
219 #define NDR_PRINT_STRUCT_STRING(ctx, type, p) ndr_print_struct_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
220 #define NDR_PRINT_UNION_STRING(ctx, type, level, p) ndr_print_union_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
221 #define NDR_PRINT_FUNCTION_STRING(ctx, type, flags, p) ndr_print_function_string(ctx, (ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
222 #define NDR_PRINT_BOTH_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_BOTH, p)
223 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
224 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
226 #define NDR_HIDE_SECRET(ndr) \
227 (unlikely(((ndr)->flags & LIBNDR_FLAG_IS_SECRET) && !(ndr)->print_secrets))
229 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
249 NDR_ERR_INVALID_POINTER,
250 NDR_ERR_UNREAD_BYTES,
253 NDR_ERR_INCOMPLETE_BUFFER
256 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
258 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
260 return NDR_ERR_ALLOC; \
264 enum ndr_compression_alg {
265 NDR_COMPRESSION_MSZIP_CAB = 1,
266 NDR_COMPRESSION_MSZIP = 2,
267 NDR_COMPRESSION_XPRESS = 3
271 flags passed to control parse flow
272 These are deliberately in a different range to the NDR_IN/NDR_OUT
273 flags to catch mixups
275 #define NDR_SCALARS 0x100
276 #define NDR_BUFFERS 0x200
279 flags passed to ndr_print_*() and ndr pull/push for functions
280 These are deliberately in a different range to the NDR_SCALARS/NDR_BUFFERS
281 flags to catch mixups
285 #define NDR_BOTH 0x30
286 #define NDR_SET_VALUES 0x40
289 #define NDR_PULL_CHECK_FLAGS(ndr, ndr_flags) do { \
290 if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) { \
291 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid pull struct ndr_flags 0x%x", ndr_flags); \
295 #define NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags) do { \
296 if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) \
297 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid push struct ndr_flags 0x%x", ndr_flags); \
300 #define NDR_PULL_CHECK_FN_FLAGS(ndr, flags) do { \
301 if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) { \
302 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid fn pull flags 0x%x", flags); \
306 #define NDR_PUSH_CHECK_FN_FLAGS(ndr, flags) do { \
307 if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) \
308 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid fn push flags 0x%x", flags); \
311 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
313 (n) > ndr->data_size || \
314 ndr->offset + (n) > ndr->data_size || \
315 ndr->offset + (n) < ndr->offset)) { \
316 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
317 uint32_t _available = ndr->data_size - ndr->offset; \
318 uint32_t _missing = n - _available; \
319 ndr->relative_highest_offset = _missing; \
321 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
325 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
327 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
329 #define NDR_PULL_ALIGN(ndr, n) do { \
330 if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) { \
331 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) { \
332 ndr_check_padding(ndr, n); \
334 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
336 if (unlikely(ndr->offset > ndr->data_size)) { \
337 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
338 uint32_t _missing = ndr->offset - ndr->data_size; \
339 ndr->relative_highest_offset = _missing; \
341 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
345 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
347 #define NDR_PUSH_ALIGN(ndr, n) do { \
348 if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) { \
349 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
350 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
354 /* these are used to make the error checking on each element in libndr
355 less tedious, hopefully making the code more readable */
356 #define NDR_CHECK(call) do { \
357 enum ndr_err_code _status; \
359 if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) { \
364 /* if the call fails then free the ndr pointer */
365 #define NDR_CHECK_FREE(call) do { \
366 enum ndr_err_code _status; \
368 if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) { \
374 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
376 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
377 if ( !(flgs) || (ndr->flags & flgs) ) {\
379 return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
381 ndr->current_mem_ctx = discard_const(mem_ctx);\
385 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
386 if (!ndr->current_mem_ctx) {\
387 ndr->current_mem_ctx = talloc_new(ndr);\
388 if (!ndr->current_mem_ctx) {\
389 return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
394 #define NDR_PULL_ALLOC(ndr, s) do { \
395 _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
396 (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
397 if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
400 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
401 _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
402 (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
403 if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
407 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
408 (s) = talloc_array(ndr, uint8_t, size); \
409 if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
412 #define NDR_PUSH_ALLOC(ndr, s) do { \
413 (s) = talloc_ptrtype(ndr, (s)); \
414 if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
417 #define NDR_ZERO_STRUCT(x) ndr_zero_memory(&(x), sizeof(x))
418 #define NDR_ZERO_STRUCTP(x) do { \
420 ndr_zero_memory((x), sizeof(*(x))); \
424 /* these are used when generic fn pointers are needed for ndr push/pull fns */
425 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
426 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
427 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
428 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
430 #include "../libcli/util/error.h"
431 #include "librpc/gen_ndr/misc.h"
433 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr;
434 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr64;
435 extern const struct ndr_syntax_id ndr_syntax_id_null;
437 struct ndr_interface_call_pipe {
439 const char *chunk_struct_name;
440 size_t chunk_struct_size;
441 ndr_push_flags_fn_t ndr_push;
442 ndr_pull_flags_fn_t ndr_pull;
443 ndr_print_fn_t ndr_print;
446 struct ndr_interface_call_pipes {
448 const struct ndr_interface_call_pipe *pipes;
451 struct ndr_interface_call {
454 ndr_push_flags_fn_t ndr_push;
455 ndr_pull_flags_fn_t ndr_pull;
456 ndr_print_function_t ndr_print;
457 struct ndr_interface_call_pipes in_pipes;
458 struct ndr_interface_call_pipes out_pipes;
461 struct ndr_interface_public_struct {
464 ndr_push_flags_fn_t ndr_push;
465 ndr_pull_flags_fn_t ndr_pull;
466 ndr_print_function_t ndr_print;
469 struct ndr_interface_string_array {
471 const char * const *names;
474 struct ndr_interface_table {
476 struct ndr_syntax_id syntax_id;
477 const char *helpstring;
479 const struct ndr_interface_call *calls;
480 uint32_t num_public_structs;
481 const struct ndr_interface_public_struct *public_structs;
482 const struct ndr_interface_string_array *endpoints;
483 const struct ndr_interface_string_array *authservices;
486 struct ndr_interface_list {
487 struct ndr_interface_list *prev, *next;
488 const struct ndr_interface_table *table;
491 struct sockaddr_storage;
493 /*********************************************************************
494 Map an NT error code from a NDR error code.
495 *********************************************************************/
496 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
497 int ndr_map_error2errno(enum ndr_err_code ndr_err);
498 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
499 #define ndr_errstr ndr_map_error2string
501 /* FIXME: Use represent_as instead */
503 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
504 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
505 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
506 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
507 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
508 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
509 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
510 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
511 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
512 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
513 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
514 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
515 void ndr_print_sockaddr_storage(struct ndr_print *ndr, const char *name, const struct sockaddr_storage *ss);
516 void ndr_zero_memory(void *ptr, size_t len);
517 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
518 char *ndr_syntax_id_to_string(TALLOC_CTX *mem_ctx, const struct ndr_syntax_id *id);
519 bool ndr_syntax_id_from_string(const char *s, struct ndr_syntax_id *id);
520 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
521 enum ndr_err_code ndr_push_struct_into_fixed_blob(DATA_BLOB *blob,
523 ndr_push_flags_fn_t fn);
524 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);
525 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
526 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
527 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
528 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
529 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
530 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
531 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
532 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
533 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
534 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
535 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
536 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
537 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
538 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
539 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
540 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
541 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
542 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
543 size_t ndr_align_size(uint32_t offset, size_t n);
544 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
545 enum ndr_err_code ndr_pull_append(struct ndr_pull *ndr, DATA_BLOB *blob);
546 enum ndr_err_code ndr_pull_pop(struct ndr_pull *ndr);
547 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
548 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
549 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
550 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
551 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
552 void ndr_print_debugc_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
553 void ndr_print_printf_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
554 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
555 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
556 void ndr_print_debugc(int dbgc_class, ndr_print_fn_t fn, const char *name, void *ptr);
557 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
558 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
559 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
560 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
561 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
562 ndr_print_function_t fn, const char *name,
563 int flags, void *ptr);
564 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
565 enum ndr_err_code _ndr_pull_error(struct ndr_pull *ndr,
566 enum ndr_err_code ndr_err,
567 const char *function,
568 const char *location,
569 const char *format, ...) PRINTF_ATTRIBUTE(5,6);
570 #define ndr_pull_error(ndr, ndr_err, ...) \
571 _ndr_pull_error(ndr, \
576 enum ndr_err_code _ndr_push_error(struct ndr_push *ndr,
577 enum ndr_err_code ndr_err,
578 const char *function,
579 const char *location,
580 const char *format, ...) PRINTF_ATTRIBUTE(5,6);
581 #define ndr_push_error(ndr, ndr_err, ...) \
582 _ndr_push_error(ndr, \
587 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
588 struct ndr_pull **_subndr,
591 enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
592 struct ndr_pull *subndr,
595 enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
596 struct ndr_push **_subndr,
599 enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
600 struct ndr_push *subndr,
603 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
604 struct ndr_token_list *list,
607 enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list *list, const void *key, uint32_t *v,
608 int(*_cmp_fn)(const void*,const void*), bool erase);
609 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list *list, const void *key, uint32_t *v);
610 uint32_t ndr_token_peek(struct ndr_token_list *list, const void *key);
611 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
612 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
613 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
614 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
615 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
616 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
617 enum ndr_err_code ndr_push_pipe_chunk_trailer(struct ndr_push *ndr, int ndr_flags, uint32_t count);
618 enum ndr_err_code ndr_check_pipe_chunk_trailer(struct ndr_pull *ndr, int ndr_flags, uint32_t count);
619 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
620 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
621 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
622 /* retrieve a switch value (for push) and remove it from the list */
623 enum ndr_err_code ndr_push_steal_switch_value(struct ndr_push *ndr,
626 /* retrieve a switch value and remove it from the list */
627 uint32_t ndr_print_steal_switch_value(struct ndr_print *ndr, const void *p);
628 /* retrieve a switch value and remove it from the list */
629 enum ndr_err_code ndr_pull_steal_switch_value(struct ndr_pull *ndr,
632 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
633 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);
634 enum ndr_err_code ndr_pull_struct_blob_all_noalloc(const DATA_BLOB *blob,
635 void *p, ndr_pull_flags_fn_t fn);
636 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);
637 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);
639 /* from libndr_basic.h */
640 #define NDR_SCALAR_PROTO(name, type) \
641 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
642 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
643 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
645 #define NDR_SCALAR_PTR_PROTO(name, type) \
646 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
647 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type **v); \
648 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
650 #define NDR_BUFFER_PROTO(name, type) \
651 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
652 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
653 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
655 NDR_SCALAR_PROTO(uint8, uint8_t)
656 NDR_SCALAR_PROTO(int8, int8_t)
657 NDR_SCALAR_PROTO(uint16, uint16_t)
658 NDR_SCALAR_PROTO(int16, int16_t)
659 NDR_SCALAR_PROTO(uint1632, uint16_t)
660 NDR_SCALAR_PROTO(uint32, uint32_t)
661 NDR_SCALAR_PROTO(uint3264, uint32_t)
662 NDR_SCALAR_PROTO(int32, int32_t)
663 NDR_SCALAR_PROTO(int3264, int32_t)
664 NDR_SCALAR_PROTO(udlong, uint64_t)
665 NDR_SCALAR_PROTO(udlongr, uint64_t)
666 NDR_SCALAR_PROTO(dlong, int64_t)
667 NDR_SCALAR_PROTO(hyper, uint64_t)
668 NDR_SCALAR_PROTO(pointer, void *)
669 NDR_SCALAR_PROTO(time_t, time_t)
670 NDR_SCALAR_PROTO(uid_t, uid_t)
671 NDR_SCALAR_PROTO(gid_t, gid_t)
672 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
673 NDR_SCALAR_PROTO(WERROR, WERROR)
674 NDR_SCALAR_PROTO(HRESULT, HRESULT)
675 NDR_SCALAR_PROTO(NTTIME, NTTIME)
676 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
677 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
678 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
679 NDR_SCALAR_PROTO(ipv4address, const char *)
680 NDR_SCALAR_PROTO(ipv6address, const char *)
681 NDR_SCALAR_PROTO(string, const char *)
682 NDR_SCALAR_PROTO(double, double)
684 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
685 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
686 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
687 bool ndr_policy_handle_empty(const struct policy_handle *h);
688 #define is_valid_policy_hnd(hnd) (!ndr_policy_handle_empty(hnd))
689 bool ndr_policy_handle_equal(const struct policy_handle *hnd1,
690 const struct policy_handle *hnd2);
692 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
693 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
694 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
695 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
696 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
697 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
698 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
699 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
700 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
701 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
702 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
703 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
704 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
705 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
706 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
707 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
708 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
709 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
710 void ndr_print_null(struct ndr_print *ndr);
711 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
712 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
713 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
714 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
715 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
716 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
717 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
718 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
721 uint32_t ndr_charset_length(const void *var, charset_t chset);
722 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
723 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
724 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
725 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
726 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
727 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
728 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
729 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
730 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);
731 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);
732 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);
733 enum ndr_err_code ndr_push_charset_to_null(struct ndr_push *ndr, int ndr_flags, const char *var, uint32_t length, uint8_t byte_mul, charset_t chset);
736 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
737 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
738 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
739 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
740 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
741 struct GUID GUID_zero(void);
742 bool GUID_all_zero(const struct GUID *u);
743 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
744 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
745 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
746 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
747 struct GUID GUID_random(void);
749 /* Format is "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x" */
750 /* 32 chars + 4 ' ' + \0 + 2 for adding {} */
751 struct GUID_txt_buf { char buf[39]; };
752 _PUBLIC_ char* GUID_buf_string(const struct GUID *guid,
753 struct GUID_txt_buf *dst);
755 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
756 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
757 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
758 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
759 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
760 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
761 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
762 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
764 _PUBLIC_ void ndr_print_bool(struct ndr_print *ndr, const char *name, const bool b);
766 _PUBLIC_ enum ndr_err_code ndr_push_timespec(struct ndr_push *ndr,
768 const struct timespec *t);
769 _PUBLIC_ enum ndr_err_code ndr_pull_timespec(struct ndr_pull *ndr,
772 _PUBLIC_ void ndr_print_timespec(struct ndr_print *ndr, const char *name,
773 const struct timespec *t);
775 _PUBLIC_ enum ndr_err_code ndr_push_timeval(struct ndr_push *ndr,
777 const struct timeval *t);
778 _PUBLIC_ enum ndr_err_code ndr_pull_timeval(struct ndr_pull *ndr,
781 _PUBLIC_ void ndr_print_timeval(struct ndr_print *ndr, const char *name,
782 const struct timeval *t);
786 #endif /* __LIBNDR_H__ */