wb_queryuser: avoid idmap_child() and use idmap_child_handle() instead
[Samba.git] / librpc / ndr / libndr.h
blob8bb0def40c059c63933a2f3bfd38a2ccb49e7674
1 /*
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. */
25 #ifndef __LIBNDR_H__
26 #define __LIBNDR_H__
28 #include <talloc.h>
29 #include "../lib/util/discard.h" /* for discard_const */
30 #include "../lib/util/data_blob.h"
31 #include "../lib/util/time.h"
32 #include "../lib/util/charset/charset.h"
35 this provides definitions for the libcli/rpc/ MSRPC library
40 We store the token mapping in an array that is resized as necessary.
42 struct ndr_token;
44 struct ndr_token_list {
45 struct ndr_token *tokens;
46 uint32_t count;
49 struct ndr_compression_state;
51 /* this is the base structure passed to routines that
52 parse MSRPC formatted data
54 note that in Samba4 we use separate routines and structures for
55 MSRPC marshalling and unmarshalling. Also note that these routines
56 are being kept deliberately very simple, and are not tied to a
57 particular transport
59 struct ndr_pull {
60 uint32_t flags; /* LIBNDR_FLAG_* */
61 uint8_t *data;
62 uint32_t data_size;
63 uint32_t offset;
65 uint32_t relative_highest_offset;
66 uint32_t relative_base_offset;
67 uint32_t relative_rap_convert;
68 struct ndr_token_list relative_base_list;
70 struct ndr_token_list relative_list;
71 struct ndr_token_list array_size_list;
72 struct ndr_token_list array_length_list;
73 struct ndr_token_list switch_list;
75 struct ndr_compression_state *cstate;
77 TALLOC_CTX *current_mem_ctx;
79 /* this is used to ensure we generate unique reference IDs
80 between request and reply */
81 uint32_t ptr_count;
82 uint32_t recursion_depth;
84 * The global maximum depth for recursion. When set it overrides the
85 * value supplied by the max_recursion idl attribute. This is needed
86 * for fuzzing as ASAN uses a low threshold for stack depth to check
87 * for stack overflow.
89 uint32_t global_max_recursion;
92 /* structure passed to functions that generate NDR formatted data */
93 struct ndr_push {
94 uint32_t flags; /* LIBNDR_FLAG_* */
95 uint8_t *data;
96 uint32_t alloc_size;
97 uint32_t offset;
98 bool fixed_buf_size;
100 uint32_t relative_base_offset;
101 uint32_t relative_end_offset;
102 struct ndr_token_list relative_base_list;
104 struct ndr_token_list switch_list;
105 struct ndr_token_list relative_list;
106 struct ndr_token_list relative_begin_list;
107 struct ndr_token_list nbt_string_list;
108 struct ndr_token_list dns_string_list;
109 struct ndr_token_list full_ptr_list;
111 struct ndr_compression_state *cstate;
113 /* this is used to ensure we generate unique reference IDs */
114 uint32_t ptr_count;
117 /* structure passed to functions that print IDL structures */
118 struct ndr_print {
119 uint32_t flags; /* LIBNDR_FLAG_* */
120 uint32_t depth;
121 struct ndr_token_list switch_list;
122 void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
123 void *private_data;
124 bool no_newline;
125 bool print_secrets;
128 #define LIBNDR_FLAG_BIGENDIAN (1U<<0)
129 #define LIBNDR_FLAG_NOALIGN (1U<<1)
131 #define LIBNDR_FLAG_STR_ASCII (1U<<2)
132 #define LIBNDR_FLAG_STR_LEN4 (1U<<3)
133 #define LIBNDR_FLAG_STR_SIZE4 (1U<<4)
134 #define LIBNDR_FLAG_STR_NOTERM (1U<<5)
135 #define LIBNDR_FLAG_STR_NULLTERM (1U<<6)
136 #define LIBNDR_FLAG_STR_SIZE2 (1U<<7)
137 #define LIBNDR_FLAG_STR_BYTESIZE (1U<<8)
138 #define LIBNDR_FLAG_STR_CONFORMANT (1U<<10)
139 #define LIBNDR_FLAG_STR_CHARLEN (1U<<11)
140 #define LIBNDR_FLAG_STR_UTF8 (1U<<12)
141 #define LIBNDR_FLAG_STR_RAW8 (1U<<13)
142 #define LIBNDR_STRING_FLAGS (0U | \
143 LIBNDR_FLAG_STR_ASCII | \
144 LIBNDR_FLAG_STR_LEN4 | \
145 LIBNDR_FLAG_STR_SIZE4 | \
146 LIBNDR_FLAG_STR_NOTERM | \
147 LIBNDR_FLAG_STR_NULLTERM | \
148 LIBNDR_FLAG_STR_SIZE2 | \
149 LIBNDR_FLAG_STR_BYTESIZE | \
150 LIBNDR_FLAG_STR_CONFORMANT | \
151 LIBNDR_FLAG_STR_CHARLEN | \
152 LIBNDR_FLAG_STR_UTF8 | \
153 LIBNDR_FLAG_STR_RAW8 | \
157 * Mark an element as SECRET, it won't be printed by
158 * via ndr_print* unless NDR_PRINT_SECRETS is specified.
160 #define LIBNDR_FLAG_IS_SECRET (1U<<14)
162 /* Disable string token compression */
163 #define LIBNDR_FLAG_NO_COMPRESSION (1U<<15)
166 * don't debug NDR_ERR_BUFSIZE failures,
167 * as the available buffer might be incomplete.
169 * return NDR_ERR_INCOMPLETE_BUFFER instead.
171 #define LIBNDR_FLAG_INCOMPLETE_BUFFER (1U<<16)
174 * This lets ndr_pull_subcontext_end() return
175 * NDR_ERR_UNREAD_BYTES.
177 #define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1U<<17)
179 /* set if relative pointers should *not* be marshalled in reverse order */
180 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1U<<18)
182 /* set if relative pointers are marshalled in reverse order */
183 #define LIBNDR_FLAG_RELATIVE_REVERSE (1U<<19)
185 #define LIBNDR_FLAG_REF_ALLOC (1U<<20)
186 #define LIBNDR_FLAG_REMAINING (1U<<21)
187 #define LIBNDR_FLAG_ALIGN2 (1U<<22)
188 #define LIBNDR_FLAG_ALIGN4 (1U<<23)
189 #define LIBNDR_FLAG_ALIGN8 (1U<<24)
191 #define LIBNDR_ALIGN_FLAGS ( 0 | \
192 LIBNDR_FLAG_NOALIGN | \
193 LIBNDR_FLAG_REMAINING | \
194 LIBNDR_FLAG_ALIGN2 | \
195 LIBNDR_FLAG_ALIGN4 | \
196 LIBNDR_FLAG_ALIGN8 | \
199 #define LIBNDR_PRINT_ARRAY_HEX (1U<<25)
200 #define LIBNDR_PRINT_SET_VALUES (1U<<26)
202 /* used to force a section of IDL to be little-endian */
203 #define LIBNDR_FLAG_LITTLE_ENDIAN (1U<<27)
205 /* used to check if alignment padding is zero */
206 #define LIBNDR_FLAG_PAD_CHECK (1U<<28)
208 #define LIBNDR_FLAG_NDR64 (1U<<29)
210 /* set if an object uuid will be present */
211 #define LIBNDR_FLAG_OBJECT_PRESENT (1U<<30)
213 /* set to avoid recursion in ndr_size_*() calculation */
214 #define LIBNDR_FLAG_NO_NDR_SIZE (1U<<31)
216 /* useful macro for debugging */
217 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
218 #define NDR_PRINT_DEBUGC(dbgc_class, type, p) ndr_print_debugc(dbgc_class, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
219 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
220 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
221 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
222 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
223 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
225 /* useful macro for debugging in strings */
226 #define NDR_PRINT_STRUCT_STRING(ctx, type, p) ndr_print_struct_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
227 #define NDR_PRINT_UNION_STRING(ctx, type, level, p) ndr_print_union_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
228 #define NDR_PRINT_FUNCTION_STRING(ctx, type, flags, p) ndr_print_function_string(ctx, (ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
229 #define NDR_PRINT_BOTH_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_BOTH, p)
230 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
231 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
233 #define NDR_HIDE_SECRET(ndr) \
234 (unlikely(((ndr)->flags & LIBNDR_FLAG_IS_SECRET) && !(ndr)->print_secrets))
236 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
238 enum ndr_err_code {
239 NDR_ERR_SUCCESS = 0,
240 NDR_ERR_ARRAY_SIZE,
241 NDR_ERR_BAD_SWITCH,
242 NDR_ERR_OFFSET,
243 NDR_ERR_RELATIVE,
244 NDR_ERR_CHARCNV,
245 NDR_ERR_LENGTH,
246 NDR_ERR_SUBCONTEXT,
247 NDR_ERR_COMPRESSION,
248 NDR_ERR_STRING,
249 NDR_ERR_VALIDATE,
250 NDR_ERR_BUFSIZE,
251 NDR_ERR_ALLOC,
252 NDR_ERR_RANGE,
253 NDR_ERR_TOKEN,
254 NDR_ERR_IPV4ADDRESS,
255 NDR_ERR_IPV6ADDRESS,
256 NDR_ERR_INVALID_POINTER,
257 NDR_ERR_UNREAD_BYTES,
258 NDR_ERR_NDR64,
259 NDR_ERR_FLAGS,
260 NDR_ERR_INCOMPLETE_BUFFER,
261 NDR_ERR_MAX_RECURSION_EXCEEDED,
262 NDR_ERR_UNDERFLOW
265 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
267 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
268 if (NULL == (x)) { \
269 return NDR_ERR_ALLOC; \
271 } while (0)
273 enum ndr_compression_alg {
274 NDR_COMPRESSION_MSZIP_CAB = 1,
275 NDR_COMPRESSION_MSZIP = 2,
276 NDR_COMPRESSION_XPRESS = 3
280 flags passed to control parse flow
281 These are deliberately in a different range to the NDR_IN/NDR_OUT
282 flags to catch mixups
284 #define NDR_SCALARS 0x100
285 #define NDR_BUFFERS 0x200
288 flags passed to ndr_print_*() and ndr pull/push for functions
289 These are deliberately in a different range to the NDR_SCALARS/NDR_BUFFERS
290 flags to catch mixups
292 #define NDR_IN 0x10
293 #define NDR_OUT 0x20
294 #define NDR_BOTH 0x30
295 #define NDR_SET_VALUES 0x40
298 #define NDR_PULL_CHECK_FLAGS(ndr, ndr_flags) do { \
299 if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) { \
300 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid pull struct ndr_flags 0x%x", ndr_flags); \
302 } while (0)
304 #define NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags) do { \
305 if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) \
306 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid push struct ndr_flags 0x%x", ndr_flags); \
307 } while (0)
309 #define NDR_PULL_CHECK_FN_FLAGS(ndr, flags) do { \
310 if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) { \
311 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid fn pull flags 0x%x", flags); \
313 } while (0)
315 #define NDR_PUSH_CHECK_FN_FLAGS(ndr, flags) do { \
316 if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) \
317 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid fn push flags 0x%x", flags); \
318 } while (0)
320 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
321 if (unlikely(\
322 (n) > ndr->data_size || \
323 ndr->offset + (n) > ndr->data_size || \
324 ndr->offset + (n) < ndr->offset)) { \
325 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
326 uint32_t _available = ndr->data_size - ndr->offset; \
327 uint32_t _missing = n - _available; \
328 ndr->relative_highest_offset = _missing; \
330 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
332 } while(0)
334 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
336 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
338 #define NDR_PULL_ALIGN(ndr, n) do { \
339 if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) { \
340 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) { \
341 ndr_check_padding(ndr, n); \
343 if(unlikely( \
344 ((ndr->offset + (n-1)) & (~(n-1))) < ndr->offset)) {\
345 return ndr_pull_error( \
346 ndr, \
347 NDR_ERR_BUFSIZE, \
348 "Pull align (overflow) %u", (unsigned)n); \
350 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
352 if (unlikely(ndr->offset > ndr->data_size)) { \
353 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
354 uint32_t _missing = ndr->offset - ndr->data_size; \
355 ndr->relative_highest_offset = _missing; \
357 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
359 } while(0)
361 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
363 #define NDR_PUSH_ALIGN(ndr, n) do { \
364 if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) { \
365 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
366 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
368 } while(0)
370 #define NDR_RECURSION_CHECK(ndr, d) do { \
371 uint32_t _ndr_min_ = (d); \
372 if (ndr->global_max_recursion && ndr->global_max_recursion < (d)) { \
373 _ndr_min_ = ndr->global_max_recursion; \
375 ndr->recursion_depth++; \
376 if (unlikely(ndr->recursion_depth > _ndr_min_)) { \
377 return ndr_pull_error( \
378 ndr, \
379 NDR_ERR_MAX_RECURSION_EXCEEDED, \
380 "Depth of recursion exceeds (%u)", \
381 (unsigned) d); \
383 } while (0)
385 #define NDR_RECURSION_UNWIND(ndr) do { \
386 if (unlikely(ndr->recursion_depth == 0)) { \
387 return ndr_pull_error( \
388 ndr, \
389 NDR_ERR_UNDERFLOW, \
390 "ndr_pull.recursion_depth is 0"); \
392 ndr->recursion_depth--; \
393 } while (0)
395 /* these are used to make the error checking on each element in libndr
396 less tedious, hopefully making the code more readable */
397 #define NDR_CHECK(call) do { \
398 enum ndr_err_code _status; \
399 _status = call; \
400 if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) { \
401 return _status; \
403 } while (0)
405 /* if the call fails then free the ndr pointer */
406 #define NDR_CHECK_FREE(call) do { \
407 enum ndr_err_code _status; \
408 _status = call; \
409 if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) { \
410 talloc_free(ndr); \
411 return _status; \
413 } while (0)
415 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
417 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
418 if ( !(flgs) || (ndr->flags & flgs) ) {\
419 if (!(mem_ctx)) {\
420 return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
422 ndr->current_mem_ctx = discard_const(mem_ctx);\
424 } while(0)
426 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
427 if (!ndr->current_mem_ctx) {\
428 ndr->current_mem_ctx = talloc_new(ndr);\
429 if (!ndr->current_mem_ctx) {\
430 return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
433 } while(0)
435 #define NDR_PULL_ALLOC(ndr, s) do { \
436 _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
437 (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
438 if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
439 } while (0)
441 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
442 _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
443 (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
444 if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
445 } while (0)
448 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
449 (s) = talloc_array(ndr, uint8_t, size); \
450 if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
451 } while (0)
453 #define NDR_PUSH_ALLOC(ndr, s) do { \
454 (s) = talloc_ptrtype(ndr, (s)); \
455 if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
456 } while (0)
458 #define NDR_ZERO_STRUCT(x) ndr_zero_memory(&(x), sizeof(x))
459 #define NDR_ZERO_STRUCTP(x) do { \
460 if ((x) != NULL) { \
461 ndr_zero_memory((x), sizeof(*(x))); \
463 } while(0)
465 /* these are used when generic fn pointers are needed for ndr push/pull fns */
466 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
467 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
468 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
469 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
471 #include "../libcli/util/error.h"
472 #include "librpc/gen_ndr/misc.h"
474 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr;
475 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr64;
476 extern const struct ndr_syntax_id ndr_syntax_id_null;
478 struct ndr_interface_call_pipe {
479 const char *name;
480 const char *chunk_struct_name;
481 size_t chunk_struct_size;
482 ndr_push_flags_fn_t ndr_push;
483 ndr_pull_flags_fn_t ndr_pull;
484 ndr_print_fn_t ndr_print;
487 struct ndr_interface_call_pipes {
488 uint32_t num_pipes;
489 const struct ndr_interface_call_pipe *pipes;
492 struct ndr_interface_call {
493 const char *name;
494 size_t struct_size;
495 ndr_push_flags_fn_t ndr_push;
496 ndr_pull_flags_fn_t ndr_pull;
497 ndr_print_function_t ndr_print;
498 struct ndr_interface_call_pipes in_pipes;
499 struct ndr_interface_call_pipes out_pipes;
502 struct ndr_interface_public_struct {
503 const char *name;
504 size_t struct_size;
505 ndr_push_flags_fn_t ndr_push;
506 ndr_pull_flags_fn_t ndr_pull;
507 ndr_print_function_t ndr_print;
510 struct ndr_interface_string_array {
511 uint32_t count;
512 const char * const *names;
515 struct ndr_interface_table {
516 const char *name;
517 struct ndr_syntax_id syntax_id;
518 const char *helpstring;
519 uint32_t num_calls;
520 const struct ndr_interface_call *calls;
521 uint32_t num_public_structs;
522 const struct ndr_interface_public_struct *public_structs;
523 const struct ndr_interface_string_array *endpoints;
524 const struct ndr_interface_string_array *authservices;
527 struct ndr_interface_list {
528 struct ndr_interface_list *prev, *next;
529 const struct ndr_interface_table *table;
532 struct sockaddr_storage;
534 /*********************************************************************
535 Map an NT error code from a NDR error code.
536 *********************************************************************/
537 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
538 int ndr_map_error2errno(enum ndr_err_code ndr_err);
539 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
540 #define ndr_errstr ndr_map_error2string
542 /* FIXME: Use represent_as instead */
543 struct dom_sid;
544 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
545 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
546 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
547 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
548 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
549 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
550 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
551 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
552 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
553 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
554 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
555 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
556 void ndr_print_sockaddr_storage(struct ndr_print *ndr, const char *name, const struct sockaddr_storage *ss);
557 void ndr_zero_memory(void *ptr, size_t len);
558 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
559 char *ndr_syntax_id_to_string(TALLOC_CTX *mem_ctx, const struct ndr_syntax_id *id);
560 bool ndr_syntax_id_from_string(const char *s, struct ndr_syntax_id *id);
561 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
562 enum ndr_err_code ndr_push_struct_into_fixed_blob(DATA_BLOB *blob,
563 const void *p,
564 ndr_push_flags_fn_t fn);
565 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);
566 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
567 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
568 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
569 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
570 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
571 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
572 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
573 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
574 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
575 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
576 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
577 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
578 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
579 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
580 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
581 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
582 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
583 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
584 size_t ndr_align_size(uint32_t offset, size_t n);
585 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
586 enum ndr_err_code ndr_pull_append(struct ndr_pull *ndr, DATA_BLOB *blob);
587 enum ndr_err_code ndr_pull_pop(struct ndr_pull *ndr);
588 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
589 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
590 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
591 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
592 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
593 void ndr_print_debugc_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
594 void ndr_print_printf_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
595 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
596 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
597 void ndr_print_debugc(int dbgc_class, ndr_print_fn_t fn, const char *name, void *ptr);
598 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
599 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
600 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
601 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
602 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
603 ndr_print_function_t fn, const char *name,
604 int flags, void *ptr);
605 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
606 enum ndr_err_code _ndr_pull_error(struct ndr_pull *ndr,
607 enum ndr_err_code ndr_err,
608 const char *function,
609 const char *location,
610 const char *format, ...) PRINTF_ATTRIBUTE(5,6);
611 #define ndr_pull_error(ndr, ndr_err, ...) \
612 _ndr_pull_error(ndr, \
613 ndr_err, \
614 __FUNCTION__, \
615 __location__, \
616 __VA_ARGS__)
617 enum ndr_err_code _ndr_push_error(struct ndr_push *ndr,
618 enum ndr_err_code ndr_err,
619 const char *function,
620 const char *location,
621 const char *format, ...) PRINTF_ATTRIBUTE(5,6);
622 #define ndr_push_error(ndr, ndr_err, ...) \
623 _ndr_push_error(ndr, \
624 ndr_err, \
625 __FUNCTION__, \
626 __location__, \
627 __VA_ARGS__)
628 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
629 struct ndr_pull **_subndr,
630 size_t header_size,
631 ssize_t size_is);
632 enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
633 struct ndr_pull *subndr,
634 size_t header_size,
635 ssize_t size_is);
636 enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
637 struct ndr_push **_subndr,
638 size_t header_size,
639 ssize_t size_is);
640 enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
641 struct ndr_push *subndr,
642 size_t header_size,
643 ssize_t size_is);
644 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
645 struct ndr_token_list *list,
646 const void *key,
647 uint32_t value);
648 enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list *list, const void *key, uint32_t *v,
649 int(*_cmp_fn)(const void*,const void*), bool erase);
650 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list *list, const void *key, uint32_t *v);
651 uint32_t ndr_token_peek(struct ndr_token_list *list, const void *key);
652 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
653 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
654 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
655 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
656 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
657 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
658 enum ndr_err_code ndr_push_pipe_chunk_trailer(struct ndr_push *ndr, int ndr_flags, uint32_t count);
659 enum ndr_err_code ndr_check_pipe_chunk_trailer(struct ndr_pull *ndr, int ndr_flags, uint32_t count);
660 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
661 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
662 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
663 /* retrieve a switch value (for push) and remove it from the list */
664 enum ndr_err_code ndr_push_steal_switch_value(struct ndr_push *ndr,
665 const void *p,
666 uint32_t *v);
667 /* retrieve a switch value and remove it from the list */
668 uint32_t ndr_print_steal_switch_value(struct ndr_print *ndr, const void *p);
669 /* retrieve a switch value and remove it from the list */
670 enum ndr_err_code ndr_pull_steal_switch_value(struct ndr_pull *ndr,
671 const void *p,
672 uint32_t *v);
673 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
674 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);
675 enum ndr_err_code ndr_pull_struct_blob_all_noalloc(const DATA_BLOB *blob,
676 void *p, ndr_pull_flags_fn_t fn);
677 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);
678 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);
680 /* from libndr_basic.h */
681 #define NDR_SCALAR_PROTO(name, type) \
682 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
683 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
684 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
686 #define NDR_SCALAR_PTR_PROTO(name, type) \
687 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
688 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type **v); \
689 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
691 #define NDR_BUFFER_PROTO(name, type) \
692 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
693 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
694 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
696 NDR_SCALAR_PROTO(uint8, uint8_t)
697 NDR_SCALAR_PROTO(int8, int8_t)
698 NDR_SCALAR_PROTO(uint16, uint16_t)
699 NDR_SCALAR_PROTO(int16, int16_t)
700 NDR_SCALAR_PROTO(uint1632, uint16_t)
701 NDR_SCALAR_PROTO(uint32, uint32_t)
702 NDR_SCALAR_PROTO(uint3264, uint32_t)
703 NDR_SCALAR_PROTO(int32, int32_t)
704 NDR_SCALAR_PROTO(int3264, int32_t)
705 NDR_SCALAR_PROTO(udlong, uint64_t)
706 NDR_SCALAR_PROTO(udlongr, uint64_t)
707 NDR_SCALAR_PROTO(dlong, int64_t)
708 NDR_SCALAR_PROTO(hyper, uint64_t)
709 NDR_SCALAR_PROTO(pointer, void *)
710 NDR_SCALAR_PROTO(time_t, time_t)
711 NDR_SCALAR_PROTO(uid_t, uid_t)
712 NDR_SCALAR_PROTO(gid_t, gid_t)
713 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
714 NDR_SCALAR_PROTO(WERROR, WERROR)
715 NDR_SCALAR_PROTO(HRESULT, HRESULT)
716 NDR_SCALAR_PROTO(NTTIME, NTTIME)
717 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
718 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
719 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
720 NDR_SCALAR_PROTO(ipv4address, const char *)
721 NDR_SCALAR_PROTO(ipv6address, const char *)
722 NDR_SCALAR_PROTO(string, const char *)
723 NDR_SCALAR_PROTO(double, double)
725 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
726 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
727 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
728 bool ndr_policy_handle_empty(const struct policy_handle *h);
729 #define is_valid_policy_hnd(hnd) (!ndr_policy_handle_empty(hnd))
730 bool ndr_policy_handle_equal(const struct policy_handle *hnd1,
731 const struct policy_handle *hnd2);
733 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
734 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
735 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
736 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
737 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
738 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
739 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
740 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
741 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
742 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
743 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
744 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
745 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
746 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
747 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
748 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
749 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
750 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
751 void ndr_print_null(struct ndr_print *ndr);
752 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
753 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
754 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
755 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
756 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
757 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
758 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
759 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
761 /* strings */
762 uint32_t ndr_charset_length(const void *var, charset_t chset);
763 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
764 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
765 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
766 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
767 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
768 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
769 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
770 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
771 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);
772 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);
773 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);
774 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);
776 /* GUIDs */
777 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
778 struct GUID_ndr_buf { uint8_t buf[16]; };
779 NTSTATUS GUID_to_ndr_buf(const struct GUID *guid, struct GUID_ndr_buf *buf);
780 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
781 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
782 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
783 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
784 struct GUID GUID_zero(void);
785 bool GUID_all_zero(const struct GUID *u);
786 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
787 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
788 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
789 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
790 struct GUID GUID_random(void);
792 /* Format is "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x" */
793 /* 32 chars + 4 ' ' + \0 + 2 for adding {} */
794 struct GUID_txt_buf { char buf[39]; };
795 _PUBLIC_ char* GUID_buf_string(const struct GUID *guid,
796 struct GUID_txt_buf *dst);
798 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
799 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
800 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
801 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
802 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
803 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
804 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
805 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
807 _PUBLIC_ void ndr_print_bool(struct ndr_print *ndr, const char *name, const bool b);
809 _PUBLIC_ enum ndr_err_code ndr_push_timespec(struct ndr_push *ndr,
810 int ndr_flags,
811 const struct timespec *t);
812 _PUBLIC_ enum ndr_err_code ndr_pull_timespec(struct ndr_pull *ndr,
813 int ndr_flags,
814 struct timespec *t);
815 _PUBLIC_ void ndr_print_timespec(struct ndr_print *ndr, const char *name,
816 const struct timespec *t);
818 _PUBLIC_ enum ndr_err_code ndr_push_timeval(struct ndr_push *ndr,
819 int ndr_flags,
820 const struct timeval *t);
821 _PUBLIC_ enum ndr_err_code ndr_pull_timeval(struct ndr_pull *ndr,
822 int ndr_flags,
823 struct timeval *t);
824 _PUBLIC_ void ndr_print_timeval(struct ndr_print *ndr, const char *name,
825 const struct timeval *t);
829 #endif /* __LIBNDR_H__ */