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