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

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

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