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

Last change on this file was 920, checked in by Silvan Scherrer, 9 years ago

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