source: vendor/current/librpc/ndr/libndr.h

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

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