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