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) (unlikely(((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         NDR_ERR_NDR64
 190 };
 191
 192 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
 193
 194 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
 195         if (NULL == (x)) { \
 196                 return NDR_ERR_ALLOC; \
 197         } \
 198 } while (0)
 199
 200 enum ndr_compression_alg {
 201         NDR_COMPRESSION_MSZIP   = 2,
 202         NDR_COMPRESSION_XPRESS  = 3
 203 };
 204
 205 /*
 206   flags passed to control parse flow
 207 */
 208 #define NDR_SCALARS 1
 209 #define NDR_BUFFERS 2
 210
 211 /*
 212   flags passed to ndr_print_*()
 213 */
 214 #define NDR_IN 1
 215 #define NDR_OUT 2
 216 #define NDR_BOTH 3
 217 #define NDR_SET_VALUES 4
 218
 219 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 220         if (unlikely((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size)) { \
 221                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
 222         } \
 223 } while(0)
 224
 225 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 226
 227 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
 228
 229 #define NDR_PULL_ALIGN(ndr, n) do { \
 230         if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {    \
 231                 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) {     \
 232                         ndr_check_padding(ndr, n); \
 233                 } \
 234                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 235         } \
 236         if (unlikely(ndr->offset > ndr->data_size)) {                   \
 237                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
 238         } \
 239 } while(0)
 240
 241 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
 242
 243 #define NDR_PUSH_ALIGN(ndr, n) do { \
 244         if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {      \
 245                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 246                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
 247         } \
 248 } while(0)
 249
 250 /* these are used to make the error checking on each element in libndr
 251    less tedious, hopefully making the code more readable */
 252 #define NDR_CHECK(call) do { \
 253         enum ndr_err_code _status; \
 254         _status = call; \
 255         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
 256                 return _status; \
 257         } \
 258 } while (0)
 259
 260 /* if the call fails then free the ndr pointer */
 261 #define NDR_CHECK_FREE(call) do { \
 262         enum ndr_err_code _status; \
 263         _status = call; \
 264         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
 265                 talloc_free(ndr);                \
 266                 return _status; \
 267         } \
 268 } while (0)
 269
 270 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
 271
 272 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
 273         if ( !(flgs) || (ndr->flags & flgs) ) {\
 274                 if (!(mem_ctx)) {\
 275                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
 276                 }\
 277                 ndr->current_mem_ctx = discard_const(mem_ctx);\
 278         }\
 279 } while(0)
 280
 281 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
 282         if (!ndr->current_mem_ctx) {\
 283                 ndr->current_mem_ctx = talloc_new(ndr);\
 284                 if (!ndr->current_mem_ctx) {\
 285                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
 286                 }\
 287         }\
 288 } while(0)
 289
 290 #define NDR_PULL_ALLOC(ndr, s) do { \
 291         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 292         (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
 293         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
 294 } while (0)
 295
 296 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
 297         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 298         (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
 299         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
 300 } while (0)
 301
 302
 303 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 304        (s) = talloc_array(ndr, uint8_t, size); \
 305        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
 306 } while (0)
 307
 308 #define NDR_PUSH_ALLOC(ndr, s) do { \
 309        (s) = talloc_ptrtype(ndr, (s)); \
 310        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
 311 } while (0)
 312
 313 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 314 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 315 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 316 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
 317 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
 318
 319 #include "../libcli/util/error.h"
 320 #include "librpc/gen_ndr/misc.h"
 321
 322 extern const struct ndr_syntax_id ndr_transfer_syntax;
 323 extern const struct ndr_syntax_id ndr64_transfer_syntax;
 324
 325 struct ndr_interface_call {
 326         const char *name;
 327         size_t struct_size;
 328         ndr_push_flags_fn_t ndr_push;
 329         ndr_pull_flags_fn_t ndr_pull;
 330         ndr_print_function_t ndr_print;
 331         bool async;
 332 };
 333
 334 struct ndr_interface_string_array {
 335         uint32_t count;
 336         const char * const *names;
 337 };
 338
 339 struct ndr_interface_table {
 340         const char *name;
 341         struct ndr_syntax_id syntax_id;
 342         const char *helpstring;
 343         uint32_t num_calls;
 344         const struct ndr_interface_call *calls;
 345         const struct ndr_interface_string_array *endpoints;
 346         const struct ndr_interface_string_array *authservices;
 347 };
 348
 349 struct ndr_interface_list {
 350         struct ndr_interface_list *prev, *next;
 351         const struct ndr_interface_table *table;
 352 };
 353
 354 /*********************************************************************
 355  Map an NT error code from a NDR error code.
 356 *********************************************************************/
 357 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
 358 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
 359
 360 /* FIXME: Use represent_as instead */
 361 struct dom_sid;
 362 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 363 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 364 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 365 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 366 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 367 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 368 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
 369 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 370 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 371 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 372 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
 373 void ndr_print_ipv4_addr(struct ndr_print *ndr, const char *name, const struct in_addr *_ip);
 374 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
 375 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
 376 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);
 377 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);
 378 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push, struct smb_iconv_convenience *);
 379 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push, struct smb_iconv_convenience *);
 380 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
 381 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
 382 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
 383 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
 384 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
 385 enum ndr_err_code ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p);
 386 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
 387 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
 388 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
 389 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
 390 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
 391 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
 392 size_t ndr_align_size(uint32_t offset, size_t n);
 393 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience);
 394 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
 395 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience);
 396 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
 397 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
 398 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 399 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 400 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
 401 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 402 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
 403 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
 404 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 405 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
 406                                 ndr_print_function_t fn, const char *name,
 407                                 int flags, void *ptr);
 408 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
 409 enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
 410                                  enum ndr_err_code ndr_err,
 411                                  const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 412 enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
 413                                  enum ndr_err_code ndr_err,
 414                                  const char *format, ...)  PRINTF_ATTRIBUTE(3,4);
 415 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
 416                                    struct ndr_pull **_subndr,
 417                                    size_t header_size,
 418                                    ssize_t size_is);
 419 enum ndr_err_code ndr_pull_subcontext_end(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_push_subcontext_start(struct ndr_push *ndr,
 424                                    struct ndr_push **_subndr,
 425                                    size_t header_size,
 426                                    ssize_t size_is);
 427 enum ndr_err_code ndr_push_subcontext_end(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_token_store(TALLOC_CTX *mem_ctx,
 432                          struct ndr_token_list **list,
 433                          const void *key,
 434                          uint32_t value);
 435 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);
 436 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v);
 437 uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key);
 438 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
 439 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
 440 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
 441 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
 442 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
 443 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
 444 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
 445 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
 446 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
 447 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p);
 448 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p);
 449 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p);
 450 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);
 451 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);
 452 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);
 453 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);
 454
 455 /* from libndr_basic.h */
 456 #define NDR_SCALAR_PROTO(name, type) \
 457 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, 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, type v);
 460
 461 #define NDR_BUFFER_PROTO(name, type) \
 462 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
 463 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 464 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
 465
 466 NDR_SCALAR_PROTO(uint8, uint8_t)
 467 NDR_SCALAR_PROTO(int8, int8_t)
 468 NDR_SCALAR_PROTO(uint16, uint16_t)
 469 NDR_SCALAR_PROTO(int16, int16_t)
 470 NDR_SCALAR_PROTO(uint32, uint32_t)
 471 NDR_SCALAR_PROTO(uint3264, uint32_t)
 472 NDR_SCALAR_PROTO(int32, int32_t)
 473 NDR_SCALAR_PROTO(udlong, uint64_t)
 474 NDR_SCALAR_PROTO(udlongr, uint64_t)
 475 NDR_SCALAR_PROTO(dlong, int64_t)
 476 NDR_SCALAR_PROTO(hyper, uint64_t)
 477 NDR_SCALAR_PROTO(pointer, void *)
 478 NDR_SCALAR_PROTO(time_t, time_t)
 479 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
 480 NDR_SCALAR_PROTO(WERROR, WERROR)
 481 NDR_SCALAR_PROTO(NTTIME, NTTIME)
 482 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
 483 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
 484 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
 485 NDR_SCALAR_PROTO(ipv4address, const char *)
 486 NDR_SCALAR_PROTO(string, const char *)
 487 NDR_SCALAR_PROTO(double, double)
 488
 489 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
 490 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
 491 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
 492 bool policy_handle_empty(struct policy_handle *h);
 493
 494 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
 495 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
 496 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
 497 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
 498 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
 499 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
 500 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
 501 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
 502 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
 503 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
 504 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
 505 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
 506 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
 507 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
 508 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, 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_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 511 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
 512 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
 513 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
 514 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
 515 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
 516
 517 /* strings */
 518 uint32_t ndr_charset_length(const void *var, charset_t chset);
 519 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
 520 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
 521 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
 522 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
 523 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
 524 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
 525 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
 526 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
 527 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);
 528 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);
 529
 530 /* GUIDs */
 531 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
 532 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
 533 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
 534 NTSTATUS NS_GUID_from_string(const char *s, struct GUID *guid);
 535 struct GUID GUID_zero(void);
 536 bool GUID_all_zero(const struct GUID *u);
 537 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
 538 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 539 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 540 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 541 char *NS_GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 542 struct GUID GUID_random(void);
 543
 544 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
 545 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 546 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
 547 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
 548 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 549 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
 550
 551 #endif /* __LIBNDR_H__ */