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