pidl: Allow ndrdump to print public structures
[gd/samba-autobuild/.git] / librpc / ndr / libndr.h
1 /*
2    Unix SMB/CIFS implementation.
3    rpc interface definitions
4
5    Copyright (C) Andrew Tridgell 2003
6
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.
11
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.
16
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/>.
19 */
20
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. */
24
25 #ifndef __LIBNDR_H__
26 #define __LIBNDR_H__
27
28 #include <talloc.h>
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"
34
35 /*
36   this provides definitions for the libcli/rpc/ MSRPC library
37 */
38
39
40 /*
41   We store the token mapping in an array that is resized as necessary.
42 */
43 struct ndr_token;
44
45 struct ndr_token_list {
46         struct ndr_token *tokens;
47         uint32_t count;
48 };
49
50 struct ndr_compression_state;
51
52 /* this is the base structure passed to routines that
53    parse MSRPC formatted data
54
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
58    particular transport
59 */
60 struct ndr_pull {
61         uint32_t flags; /* LIBNDR_FLAG_* */
62         uint8_t *data;
63         uint32_t data_size;
64         uint32_t offset;
65
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;
70
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;
75
76         struct ndr_compression_state *cstate;
77
78         TALLOC_CTX *current_mem_ctx;
79
80         /* this is used to ensure we generate unique reference IDs
81            between request and reply */
82         uint32_t ptr_count;
83 };
84
85 /* structure passed to functions that generate NDR formatted data */
86 struct ndr_push {
87         uint32_t flags; /* LIBNDR_FLAG_* */
88         uint8_t *data;
89         uint32_t alloc_size;
90         uint32_t offset;
91         bool fixed_buf_size;
92
93         uint32_t relative_base_offset;
94         uint32_t relative_end_offset;
95         struct ndr_token_list relative_base_list;
96
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;
103
104         struct ndr_compression_state *cstate;
105
106         /* this is used to ensure we generate unique reference IDs */
107         uint32_t ptr_count;
108 };
109
110 /* structure passed to functions that print IDL structures */
111 struct ndr_print {
112         uint32_t flags; /* LIBNDR_FLAG_* */
113         uint32_t depth;
114         struct ndr_token_list switch_list;
115         void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
116         void *private_data;
117         bool no_newline;
118         bool print_secrets;
119 };
120
121 #define LIBNDR_FLAG_BIGENDIAN  (1U<<0)
122 #define LIBNDR_FLAG_NOALIGN    (1U<<1)
123
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 | \
147                 0)
148
149 /*
150  * Mark an element as SECRET, it won't be printed by
151  * via ndr_print* unless NDR_PRINT_SECRETS is specified.
152  */
153 #define LIBNDR_FLAG_IS_SECRET           (1U<<14)
154
155 /* Disable string token compression  */
156 #define LIBNDR_FLAG_NO_COMPRESSION      (1U<<15)
157
158 /*
159  * don't debug NDR_ERR_BUFSIZE failures,
160  * as the available buffer might be incomplete.
161  *
162  * return NDR_ERR_INCOMPLETE_BUFFER instead.
163  */
164 #define LIBNDR_FLAG_INCOMPLETE_BUFFER (1U<<16)
165
166 /*
167  * This lets ndr_pull_subcontext_end() return
168  * NDR_ERR_UNREAD_BYTES.
169  */
170 #define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1U<<17)
171
172 /* set if relative pointers should *not* be marshalled in reverse order */
173 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1U<<18)
174
175 /* set if relative pointers are marshalled in reverse order */
176 #define LIBNDR_FLAG_RELATIVE_REVERSE    (1U<<19)
177
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)
183
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    | \
190                 0)
191
192 #define LIBNDR_PRINT_ARRAY_HEX   (1U<<25)
193 #define LIBNDR_PRINT_SET_VALUES  (1U<<26)
194
195 /* used to force a section of IDL to be little-endian */
196 #define LIBNDR_FLAG_LITTLE_ENDIAN (1U<<27)
197
198 /* used to check if alignment padding is zero */
199 #define LIBNDR_FLAG_PAD_CHECK     (1U<<28)
200
201 #define LIBNDR_FLAG_NDR64         (1U<<29)
202
203 /* set if an object uuid will be present */
204 #define LIBNDR_FLAG_OBJECT_PRESENT    (1U<<30)
205
206 /* set to avoid recursion in ndr_size_*() calculation */
207 #define LIBNDR_FLAG_NO_NDR_SIZE         (1U<<31)
208
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)
217
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)
225
226 #define NDR_HIDE_SECRET(ndr) \
227         (unlikely(((ndr)->flags & LIBNDR_FLAG_IS_SECRET) && !(ndr)->print_secrets))
228
229 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
230
231 enum ndr_err_code {
232         NDR_ERR_SUCCESS = 0,
233         NDR_ERR_ARRAY_SIZE,
234         NDR_ERR_BAD_SWITCH,
235         NDR_ERR_OFFSET,
236         NDR_ERR_RELATIVE,
237         NDR_ERR_CHARCNV,
238         NDR_ERR_LENGTH,
239         NDR_ERR_SUBCONTEXT,
240         NDR_ERR_COMPRESSION,
241         NDR_ERR_STRING,
242         NDR_ERR_VALIDATE,
243         NDR_ERR_BUFSIZE,
244         NDR_ERR_ALLOC,
245         NDR_ERR_RANGE,
246         NDR_ERR_TOKEN,
247         NDR_ERR_IPV4ADDRESS,
248         NDR_ERR_IPV6ADDRESS,
249         NDR_ERR_INVALID_POINTER,
250         NDR_ERR_UNREAD_BYTES,
251         NDR_ERR_NDR64,
252         NDR_ERR_FLAGS,
253         NDR_ERR_INCOMPLETE_BUFFER
254 };
255
256 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
257
258 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
259         if (NULL == (x)) { \
260                 return NDR_ERR_ALLOC; \
261         } \
262 } while (0)
263
264 enum ndr_compression_alg {
265         NDR_COMPRESSION_MSZIP_CAB = 1,
266         NDR_COMPRESSION_MSZIP   = 2,
267         NDR_COMPRESSION_XPRESS  = 3
268 };
269
270 /*
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
274 */
275 #define NDR_SCALARS    0x100
276 #define NDR_BUFFERS    0x200
277
278 /*
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
282 */
283 #define NDR_IN         0x10
284 #define NDR_OUT        0x20
285 #define NDR_BOTH       0x30
286 #define NDR_SET_VALUES 0x40
287
288
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); \
292         } \
293 } while (0)
294
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); \
298 } while (0)
299
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); \
303         } \
304 } while (0)
305
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); \
309 } while (0)
310
311 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
312         if (unlikely((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size)) { \
313                 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
314                         uint32_t _available = ndr->data_size - ndr->offset; \
315                         uint32_t _missing = n - _available; \
316                         ndr->relative_highest_offset = _missing; \
317                 } \
318                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
319         } \
320 } while(0)
321
322 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
323
324 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
325
326 #define NDR_PULL_ALIGN(ndr, n) do { \
327         if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {    \
328                 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) {     \
329                         ndr_check_padding(ndr, n); \
330                 } \
331                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
332         } \
333         if (unlikely(ndr->offset > ndr->data_size)) {                   \
334                 if (ndr->flags & LIBNDR_FLAG_INCOMPLETE_BUFFER) { \
335                         uint32_t _missing = ndr->offset - ndr->data_size; \
336                         ndr->relative_highest_offset = _missing; \
337                 } \
338                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
339         } \
340 } while(0)
341
342 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
343
344 #define NDR_PUSH_ALIGN(ndr, n) do { \
345         if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {      \
346                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
347                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
348         } \
349 } while(0)
350
351 /* these are used to make the error checking on each element in libndr
352    less tedious, hopefully making the code more readable */
353 #define NDR_CHECK(call) do { \
354         enum ndr_err_code _status; \
355         _status = call; \
356         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
357                 return _status; \
358         } \
359 } while (0)
360
361 /* if the call fails then free the ndr pointer */
362 #define NDR_CHECK_FREE(call) do { \
363         enum ndr_err_code _status; \
364         _status = call; \
365         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
366                 talloc_free(ndr);                \
367                 return _status; \
368         } \
369 } while (0)
370
371 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
372
373 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
374         if ( !(flgs) || (ndr->flags & flgs) ) {\
375                 if (!(mem_ctx)) {\
376                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
377                 }\
378                 ndr->current_mem_ctx = discard_const(mem_ctx);\
379         }\
380 } while(0)
381
382 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
383         if (!ndr->current_mem_ctx) {\
384                 ndr->current_mem_ctx = talloc_new(ndr);\
385                 if (!ndr->current_mem_ctx) {\
386                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
387                 }\
388         }\
389 } while(0)
390
391 #define NDR_PULL_ALLOC(ndr, s) do { \
392         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
393         (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
394         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
395 } while (0)
396
397 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
398         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
399         (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
400         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
401 } while (0)
402
403
404 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
405        (s) = talloc_array(ndr, uint8_t, size); \
406        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
407 } while (0)
408
409 #define NDR_PUSH_ALLOC(ndr, s) do { \
410        (s) = talloc_ptrtype(ndr, (s)); \
411        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
412 } while (0)
413
414 #define NDR_ZERO_STRUCT(x) ndr_zero_memory(&(x), sizeof(x))
415 #define NDR_ZERO_STRUCTP(x) do { \
416         if ((x) != NULL) { \
417                 ndr_zero_memory((x), sizeof(*(x))); \
418         } \
419 } while(0)
420
421 /* these are used when generic fn pointers are needed for ndr push/pull fns */
422 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
423 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
424 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
425 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
426
427 #include "../libcli/util/error.h"
428 #include "librpc/gen_ndr/misc.h"
429
430 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr;
431 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr64;
432 extern const struct ndr_syntax_id ndr_syntax_id_null;
433
434 struct ndr_interface_call_pipe {
435         const char *name;
436         const char *chunk_struct_name;
437         size_t chunk_struct_size;
438         ndr_push_flags_fn_t ndr_push;
439         ndr_pull_flags_fn_t ndr_pull;
440         ndr_print_fn_t ndr_print;
441 };
442
443 struct ndr_interface_call_pipes {
444         uint32_t num_pipes;
445         const struct ndr_interface_call_pipe *pipes;
446 };
447
448 struct ndr_interface_call {
449         const char *name;
450         size_t struct_size;
451         ndr_push_flags_fn_t ndr_push;
452         ndr_pull_flags_fn_t ndr_pull;
453         ndr_print_function_t ndr_print;
454         struct ndr_interface_call_pipes in_pipes;
455         struct ndr_interface_call_pipes out_pipes;
456 };
457
458 struct ndr_interface_public_struct {
459         const char *name;
460         size_t struct_size;
461         ndr_push_flags_fn_t ndr_push;
462         ndr_pull_flags_fn_t ndr_pull;
463         ndr_print_function_t ndr_print;
464 };
465
466 struct ndr_interface_string_array {
467         uint32_t count;
468         const char * const *names;
469 };
470
471 struct ndr_interface_table {
472         const char *name;
473         struct ndr_syntax_id syntax_id;
474         const char *helpstring;
475         uint32_t num_calls;
476         const struct ndr_interface_call *calls;
477         uint32_t num_public_structs;
478         const struct ndr_interface_public_struct *public_structs;
479         const struct ndr_interface_string_array *endpoints;
480         const struct ndr_interface_string_array *authservices;
481 };
482
483 struct ndr_interface_list {
484         struct ndr_interface_list *prev, *next;
485         const struct ndr_interface_table *table;
486 };
487
488 struct sockaddr_storage;
489
490 /*********************************************************************
491  Map an NT error code from a NDR error code.
492 *********************************************************************/
493 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
494 int ndr_map_error2errno(enum ndr_err_code ndr_err);
495 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
496 #define ndr_errstr ndr_map_error2string
497
498 /* FIXME: Use represent_as instead */
499 struct dom_sid;
500 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
501 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
502 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
503 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
504 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
505 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
506 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
507 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
508 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
509 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
510 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
511 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
512 void ndr_print_sockaddr_storage(struct ndr_print *ndr, const char *name, const struct sockaddr_storage *ss);
513 void ndr_zero_memory(void *ptr, size_t len);
514 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
515 char *ndr_syntax_id_to_string(TALLOC_CTX *mem_ctx, const struct ndr_syntax_id *id);
516 bool ndr_syntax_id_from_string(const char *s, struct ndr_syntax_id *id);
517 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
518 enum ndr_err_code ndr_push_struct_into_fixed_blob(DATA_BLOB *blob,
519                                                   const void *p,
520                                                   ndr_push_flags_fn_t fn);
521 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);
522 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
523 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
524 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
525 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
526 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
527 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
528 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
529 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
530 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
531 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
532 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
533 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
534 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
535 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
536 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
537 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
538 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
539 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
540 size_t ndr_align_size(uint32_t offset, size_t n);
541 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
542 enum ndr_err_code ndr_pull_append(struct ndr_pull *ndr, DATA_BLOB *blob);
543 enum ndr_err_code ndr_pull_pop(struct ndr_pull *ndr);
544 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
545 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
546 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
547 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
548 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
549 void ndr_print_debugc_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
550 void ndr_print_printf_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
551 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
552 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
553 void ndr_print_debugc(int dbgc_class, ndr_print_fn_t fn, const char *name, void *ptr);
554 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
555 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
556 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
557 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
558 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
559                                 ndr_print_function_t fn, const char *name,
560                                 int flags, void *ptr);
561 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
562 enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
563                                  enum ndr_err_code ndr_err,
564                                  const char *format, ...) PRINTF_ATTRIBUTE(3,4);
565 enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
566                                  enum ndr_err_code ndr_err,
567                                  const char *format, ...)  PRINTF_ATTRIBUTE(3,4);
568 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
569                                    struct ndr_pull **_subndr,
570                                    size_t header_size,
571                                    ssize_t size_is);
572 enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
573                                  struct ndr_pull *subndr,
574                                  size_t header_size,
575                                  ssize_t size_is);
576 enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
577                                    struct ndr_push **_subndr,
578                                    size_t header_size,
579                                    ssize_t size_is);
580 enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
581                                  struct ndr_push *subndr,
582                                  size_t header_size,
583                                  ssize_t size_is);
584 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
585                          struct ndr_token_list *list,
586                          const void *key,
587                          uint32_t value);
588 enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list *list, const void *key, uint32_t *v,
589                                             int(*_cmp_fn)(const void*,const void*), bool erase);
590 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list *list, const void *key, uint32_t *v);
591 uint32_t ndr_token_peek(struct ndr_token_list *list, const void *key);
592 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
593 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
594 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
595 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
596 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
597 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
598 enum ndr_err_code ndr_push_pipe_chunk_trailer(struct ndr_push *ndr, int ndr_flags, uint32_t count);
599 enum ndr_err_code ndr_check_pipe_chunk_trailer(struct ndr_pull *ndr, int ndr_flags, uint32_t count);
600 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
601 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
602 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
603 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p);
604 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p);
605 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p);
606 uint32_t ndr_pull_steal_switch_value(struct ndr_pull *ndr, const void *p);
607 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
608 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);
609 enum ndr_err_code ndr_pull_struct_blob_all_noalloc(const DATA_BLOB *blob,
610                                                    void *p, ndr_pull_flags_fn_t fn);
611 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);
612 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);
613
614 /* from libndr_basic.h */
615 #define NDR_SCALAR_PROTO(name, type) \
616 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
617 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
618 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
619
620 #define NDR_SCALAR_PTR_PROTO(name, type) \
621 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
622 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type **v); \
623 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
624
625 #define NDR_BUFFER_PROTO(name, type) \
626 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
627 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
628 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
629
630 NDR_SCALAR_PROTO(uint8, uint8_t)
631 NDR_SCALAR_PROTO(int8, int8_t)
632 NDR_SCALAR_PROTO(uint16, uint16_t)
633 NDR_SCALAR_PROTO(int16, int16_t)
634 NDR_SCALAR_PROTO(uint1632, uint16_t)
635 NDR_SCALAR_PROTO(uint32, uint32_t)
636 NDR_SCALAR_PROTO(uint3264, uint32_t)
637 NDR_SCALAR_PROTO(int32, int32_t)
638 NDR_SCALAR_PROTO(int3264, int32_t)
639 NDR_SCALAR_PROTO(udlong, uint64_t)
640 NDR_SCALAR_PROTO(udlongr, uint64_t)
641 NDR_SCALAR_PROTO(dlong, int64_t)
642 NDR_SCALAR_PROTO(hyper, uint64_t)
643 NDR_SCALAR_PROTO(pointer, void *)
644 NDR_SCALAR_PROTO(time_t, time_t)
645 NDR_SCALAR_PROTO(uid_t, uid_t)
646 NDR_SCALAR_PROTO(gid_t, gid_t)
647 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
648 NDR_SCALAR_PROTO(WERROR, WERROR)
649 NDR_SCALAR_PROTO(HRESULT, HRESULT)
650 NDR_SCALAR_PROTO(NTTIME, NTTIME)
651 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
652 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
653 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
654 NDR_SCALAR_PROTO(ipv4address, const char *)
655 NDR_SCALAR_PROTO(ipv6address, const char *)
656 NDR_SCALAR_PROTO(string, const char *)
657 NDR_SCALAR_PROTO(double, double)
658
659 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
660 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
661 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
662 bool ndr_policy_handle_empty(const struct policy_handle *h);
663 #define is_valid_policy_hnd(hnd) (!ndr_policy_handle_empty(hnd))
664 bool ndr_policy_handle_equal(const struct policy_handle *hnd1,
665                          const struct policy_handle *hnd2);
666
667 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
668 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
669 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
670 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
671 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
672 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
673 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
674 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
675 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
676 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
677 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
678 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
679 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
680 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
681 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
682 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
683 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
684 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
685 void ndr_print_null(struct ndr_print *ndr);
686 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
687 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
688 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
689 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
690 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
691 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
692 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
693 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
694
695 /* strings */
696 uint32_t ndr_charset_length(const void *var, charset_t chset);
697 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
698 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
699 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
700 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
701 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
702 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
703 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
704 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
705 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);
706 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);
707 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);
708 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);
709
710 /* GUIDs */
711 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
712 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
713 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
714 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
715 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
716 struct GUID GUID_zero(void);
717 bool GUID_all_zero(const struct GUID *u);
718 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
719 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
720 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
721 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
722 struct GUID GUID_random(void);
723
724 /* Format is "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x" */
725  /* 32 chars + 4 ' ' + \0 + 2 for adding {}  */
726 struct GUID_txt_buf { char buf[39]; };
727 _PUBLIC_ char* GUID_buf_string(const struct GUID *guid,
728                                struct GUID_txt_buf *dst);
729
730 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
731 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
732 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
733 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
734 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
735 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
736 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
737 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
738
739 _PUBLIC_ void ndr_print_bool(struct ndr_print *ndr, const char *name, const bool b);
740
741 _PUBLIC_ enum ndr_err_code ndr_push_timespec(struct ndr_push *ndr,
742                                              int ndr_flags,
743                                              const struct timespec *t);
744 _PUBLIC_ enum ndr_err_code ndr_pull_timespec(struct ndr_pull *ndr,
745                                              int ndr_flags,
746                                              struct timespec *t);
747 _PUBLIC_ void ndr_print_timespec(struct ndr_print *ndr, const char *name,
748                                  const struct timespec *t);
749
750 _PUBLIC_ enum ndr_err_code ndr_push_timeval(struct ndr_push *ndr,
751                                             int ndr_flags,
752                                             const struct timeval *t);
753 _PUBLIC_ enum ndr_err_code ndr_pull_timeval(struct ndr_pull *ndr,
754                                             int ndr_flags,
755                                             struct timeval *t);
756 _PUBLIC_ void ndr_print_timeval(struct ndr_print *ndr, const char *name,
757                                 const struct timeval *t);
758
759
760
761 #endif /* __LIBNDR_H__ */