source: trunk/server/librpc/ndr/libndr.h@ 745

Last change on this file since 745 was 745, checked in by Silvan Scherrer, 13 years ago

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