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