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