librpc/ndr/libndr.h

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