Finish removal of iconv_convenience in public API's.
[bbaumbach/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 <sys/time.h>
30 #if _SAMBA_BUILD_ == 4
31 #include "../lib/util/util.h" /* for discard_const */
32 #include "../lib/util/charset/charset.h"
33 #endif
34
35 /*
36   this provides definitions for the libcli/rpc/ MSRPC library
37 */
38
39
40 /*
41   this is used by the token store/retrieve code
42 */
43 struct ndr_token_list {
44         struct ndr_token_list *next, *prev;
45         const void *key;
46         uint32_t value;
47 };
48
49 /* this is the base structure passed to routines that 
50    parse MSRPC formatted data 
51
52    note that in Samba4 we use separate routines and structures for
53    MSRPC marshalling and unmarshalling. Also note that these routines
54    are being kept deliberately very simple, and are not tied to a
55    particular transport
56 */
57 struct ndr_pull {
58         uint32_t flags; /* LIBNDR_FLAG_* */
59         uint8_t *data;
60         uint32_t data_size;
61         uint32_t offset;
62
63         uint32_t relative_highest_offset;
64         uint32_t relative_base_offset;
65         struct ndr_token_list *relative_base_list;
66
67         struct ndr_token_list *relative_list;
68         struct ndr_token_list *array_size_list;
69         struct ndr_token_list *array_length_list;
70         struct ndr_token_list *switch_list;
71
72         TALLOC_CTX *current_mem_ctx;
73
74         /* this is used to ensure we generate unique reference IDs
75            between request and reply */
76         uint32_t ptr_count;
77 };
78
79 /* structure passed to functions that generate NDR formatted data */
80 struct ndr_push {
81         uint32_t flags; /* LIBNDR_FLAG_* */
82         uint8_t *data;
83         uint32_t alloc_size;
84         uint32_t offset;
85
86         uint32_t relative_base_offset;
87         uint32_t relative_end_offset;
88         struct ndr_token_list *relative_base_list;
89
90         struct ndr_token_list *switch_list;
91         struct ndr_token_list *relative_list;
92         struct ndr_token_list *relative_begin_list;
93         struct ndr_token_list *nbt_string_list;
94         struct ndr_token_list *full_ptr_list;
95
96         /* this is used to ensure we generate unique reference IDs */
97         uint32_t ptr_count;
98 };
99
100 /* structure passed to functions that print IDL structures */
101 struct ndr_print {
102         uint32_t flags; /* LIBNDR_FLAG_* */
103         uint32_t depth;
104         struct ndr_token_list *switch_list;
105         void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
106         void *private_data;
107 };
108
109 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
110 #define LIBNDR_FLAG_NOALIGN    (1<<1)
111
112 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
113 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
114 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
115 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
116 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
117 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
118 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
119 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
120 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
121 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
122 #define LIBNDR_STRING_FLAGS             (0x7FFC)
123
124 /* set if relative pointers should *not* be marshalled in reverse order */
125 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1<<18)
126
127 /* set if relative pointers are marshalled in reverse order */
128 #define LIBNDR_FLAG_RELATIVE_REVERSE    (1<<19)
129
130 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
131 #define LIBNDR_FLAG_REMAINING    (1<<21)
132 #define LIBNDR_FLAG_ALIGN2       (1<<22)
133 #define LIBNDR_FLAG_ALIGN4       (1<<23)
134 #define LIBNDR_FLAG_ALIGN8       (1<<24)
135
136 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
137
138 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
139 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
140
141 /* used to force a section of IDL to be little-endian */
142 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
143
144 /* used to check if alignment padding is zero */
145 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
146
147 #define LIBNDR_FLAG_NDR64         (1<<29)
148
149 /* set if an object uuid will be present */
150 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
151
152 /* set to avoid recursion in ndr_size_*() calculation */
153 #define LIBNDR_FLAG_NO_NDR_SIZE         (1<<31)
154
155 /* useful macro for debugging */
156 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
157 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
158 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
159 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
160 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
161 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
162
163 /* useful macro for debugging in strings */
164 #define NDR_PRINT_STRUCT_STRING(ctx, type, p) ndr_print_struct_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
165 #define NDR_PRINT_UNION_STRING(ctx, type, level, p) ndr_print_union_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
166 #define NDR_PRINT_FUNCTION_STRING(ctx, type, flags, p) ndr_print_function_string(ctx, (ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
167 #define NDR_PRINT_BOTH_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_BOTH, p)
168 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
169 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
170
171 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
172
173 enum ndr_err_code {
174         NDR_ERR_SUCCESS = 0,
175         NDR_ERR_ARRAY_SIZE,
176         NDR_ERR_BAD_SWITCH,
177         NDR_ERR_OFFSET,
178         NDR_ERR_RELATIVE,
179         NDR_ERR_CHARCNV,
180         NDR_ERR_LENGTH,
181         NDR_ERR_SUBCONTEXT,
182         NDR_ERR_COMPRESSION,
183         NDR_ERR_STRING,
184         NDR_ERR_VALIDATE,
185         NDR_ERR_BUFSIZE,
186         NDR_ERR_ALLOC,
187         NDR_ERR_RANGE,
188         NDR_ERR_TOKEN,
189         NDR_ERR_IPV4ADDRESS,
190         NDR_ERR_INVALID_POINTER,
191         NDR_ERR_UNREAD_BYTES,
192         NDR_ERR_NDR64
193 };
194
195 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
196
197 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
198         if (NULL == (x)) { \
199                 return NDR_ERR_ALLOC; \
200         } \
201 } while (0)
202
203 enum ndr_compression_alg {
204         NDR_COMPRESSION_MSZIP   = 2,
205         NDR_COMPRESSION_XPRESS  = 3
206 };
207
208 /*
209   flags passed to control parse flow
210 */
211 #define NDR_SCALARS 1
212 #define NDR_BUFFERS 2
213
214 /*
215   flags passed to ndr_print_*()
216 */
217 #define NDR_IN 1
218 #define NDR_OUT 2
219 #define NDR_BOTH 3
220 #define NDR_SET_VALUES 4
221
222 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
223         if (unlikely((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size)) { \
224                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
225         } \
226 } while(0)
227
228 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
229
230 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
231
232 #define NDR_PULL_ALIGN(ndr, n) do { \
233         if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {    \
234                 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) {     \
235                         ndr_check_padding(ndr, n); \
236                 } \
237                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
238         } \
239         if (unlikely(ndr->offset > ndr->data_size)) {                   \
240                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
241         } \
242 } while(0)
243
244 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
245
246 #define NDR_PUSH_ALIGN(ndr, n) do { \
247         if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {      \
248                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
249                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
250         } \
251 } while(0)
252
253 /* these are used to make the error checking on each element in libndr
254    less tedious, hopefully making the code more readable */
255 #define NDR_CHECK(call) do { \
256         enum ndr_err_code _status; \
257         _status = call; \
258         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
259                 return _status; \
260         } \
261 } while (0)
262
263 /* if the call fails then free the ndr pointer */
264 #define NDR_CHECK_FREE(call) do { \
265         enum ndr_err_code _status; \
266         _status = call; \
267         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
268                 talloc_free(ndr);                \
269                 return _status; \
270         } \
271 } while (0)
272
273 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
274
275 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
276         if ( !(flgs) || (ndr->flags & flgs) ) {\
277                 if (!(mem_ctx)) {\
278                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
279                 }\
280                 ndr->current_mem_ctx = discard_const(mem_ctx);\
281         }\
282 } while(0)
283
284 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
285         if (!ndr->current_mem_ctx) {\
286                 ndr->current_mem_ctx = talloc_new(ndr);\
287                 if (!ndr->current_mem_ctx) {\
288                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
289                 }\
290         }\
291 } while(0)
292
293 #define NDR_PULL_ALLOC(ndr, s) do { \
294         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
295         (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
296         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
297 } while (0)
298
299 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
300         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
301         (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
302         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
303 } while (0)
304
305
306 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
307        (s) = talloc_array(ndr, uint8_t, size); \
308        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
309 } while (0)
310
311 #define NDR_PUSH_ALLOC(ndr, s) do { \
312        (s) = talloc_ptrtype(ndr, (s)); \
313        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
314 } while (0)
315
316 /* these are used when generic fn pointers are needed for ndr push/pull fns */
317 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
318 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
319 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
320 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
321
322 #include "../libcli/util/error.h"
323 #include "librpc/gen_ndr/misc.h"
324
325 extern const struct ndr_syntax_id ndr_transfer_syntax;
326 extern const struct ndr_syntax_id ndr64_transfer_syntax;
327
328 struct ndr_interface_call {
329         const char *name;
330         size_t struct_size;
331         ndr_push_flags_fn_t ndr_push;
332         ndr_pull_flags_fn_t ndr_pull;
333         ndr_print_function_t ndr_print;
334         bool async;
335 };
336
337 struct ndr_interface_string_array {
338         uint32_t count;
339         const char * const *names;
340 };
341
342 struct ndr_interface_table {
343         const char *name;
344         struct ndr_syntax_id syntax_id;
345         const char *helpstring;
346         uint32_t num_calls;
347         const struct ndr_interface_call *calls;
348         const struct ndr_interface_string_array *endpoints;
349         const struct ndr_interface_string_array *authservices;
350 };
351
352 struct ndr_interface_list {
353         struct ndr_interface_list *prev, *next;
354         const struct ndr_interface_table *table;
355 };
356
357 /*********************************************************************
358  Map an NT error code from a NDR error code.
359 *********************************************************************/
360 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
361 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
362
363 /* FIXME: Use represent_as instead */
364 struct dom_sid;
365 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
366 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
367 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
368 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
369 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
370 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
371 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
372 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
373 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
374 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
375 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
376 void ndr_print_ipv4_addr(struct ndr_print *ndr, const char *name, const struct in_addr *_ip);
377 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
378 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2); 
379 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
380 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);
381 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
382 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
383 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
384 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
385 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
386 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
387 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
388 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
389 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
390 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
391 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
392 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
393 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
394 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
395 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
396 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
397 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
398 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
399 size_t ndr_align_size(uint32_t offset, size_t n);
400 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
401 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
402 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
403 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
404 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
405 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
406 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
407 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
408 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
409 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
410 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
411 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
412 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
413                                 ndr_print_function_t fn, const char *name, 
414                                 int flags, void *ptr);
415 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
416 enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
417                                  enum ndr_err_code ndr_err,
418                                  const char *format, ...) PRINTF_ATTRIBUTE(3,4);
419 enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
420                                  enum ndr_err_code ndr_err,
421                                  const char *format, ...)  PRINTF_ATTRIBUTE(3,4);
422 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
423                                    struct ndr_pull **_subndr,
424                                    size_t header_size,
425                                    ssize_t size_is);
426 enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
427                                  struct ndr_pull *subndr,
428                                  size_t header_size,
429                                  ssize_t size_is);
430 enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
431                                    struct ndr_push **_subndr,
432                                    size_t header_size,
433                                    ssize_t size_is);
434 enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
435                                  struct ndr_push *subndr,
436                                  size_t header_size,
437                                  ssize_t size_is);
438 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
439                          struct ndr_token_list **list, 
440                          const void *key, 
441                          uint32_t value);
442 enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list **list, const void *key, uint32_t *v, int(*_cmp_fn)(const void*,const void*), bool _remove_tok);
443 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v);
444 uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key);
445 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
446 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
447 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
448 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
449 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
450 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
451 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
452 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
453 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
454 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p);
455 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p);
456 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p);
457 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
458 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);
459 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);
460 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);
461
462 /* from libndr_basic.h */
463 #define NDR_SCALAR_PROTO(name, type) \
464 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
465 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
466 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v); 
467
468 #define NDR_BUFFER_PROTO(name, type) \
469 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
470 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
471 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v); 
472
473 NDR_SCALAR_PROTO(uint8, uint8_t)
474 NDR_SCALAR_PROTO(int8, int8_t)
475 NDR_SCALAR_PROTO(uint16, uint16_t)
476 NDR_SCALAR_PROTO(int16, int16_t)
477 NDR_SCALAR_PROTO(uint1632, uint16_t)
478 NDR_SCALAR_PROTO(uint32, uint32_t)
479 NDR_SCALAR_PROTO(uint3264, uint32_t)
480 NDR_SCALAR_PROTO(int32, int32_t)
481 NDR_SCALAR_PROTO(int3264, int32_t)
482 NDR_SCALAR_PROTO(udlong, uint64_t)
483 NDR_SCALAR_PROTO(udlongr, uint64_t)
484 NDR_SCALAR_PROTO(dlong, int64_t)
485 NDR_SCALAR_PROTO(hyper, uint64_t)
486 NDR_SCALAR_PROTO(pointer, void *)
487 NDR_SCALAR_PROTO(time_t, time_t)
488 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
489 NDR_SCALAR_PROTO(WERROR, WERROR)
490 NDR_SCALAR_PROTO(NTTIME, NTTIME)
491 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
492 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
493 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
494 NDR_SCALAR_PROTO(ipv4address, const char *)
495 NDR_SCALAR_PROTO(string, const char *)
496 NDR_SCALAR_PROTO(double, double)
497
498 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
499 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
500 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
501 bool policy_handle_empty(struct policy_handle *h);
502
503 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
504 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
505 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
506 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
507 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
508 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
509 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
510 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
511 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
512 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
513 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
514 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
515 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
516 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
517 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
518 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
519 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
520 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
521 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
522 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
523 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
524 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
525 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
526 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
527 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
528 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
529
530 /* strings */
531 uint32_t ndr_charset_length(const void *var, charset_t chset);
532 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
533 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
534 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
535 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
536 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
537 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
538 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
539 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
540 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);
541 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);
542
543 /* GUIDs */
544 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
545 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
546 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
547 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
548 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
549 NTSTATUS NS_GUID_from_string(const char *s, struct GUID *guid);
550 struct GUID GUID_zero(void);
551 bool GUID_all_zero(const struct GUID *u);
552 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
553 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
554 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
555 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
556 char *NS_GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
557 struct GUID GUID_random(void);
558
559 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
560 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
561 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
562 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
563 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
564 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
565 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
566 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
567
568 #endif /* __LIBNDR_H__ */