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         uint32_t relative_highest_offset;
  64         uint32_t relative_base_offset;
  65         uint32_t relative_rap_convert;
  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
 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         void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 107         void *private_data;
 108 };
 109
 110 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
 111 #define LIBNDR_FLAG_NOALIGN    (1<<1)
 112
 113 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
 114 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
 115 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
 116 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
 117 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
 118 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
 119 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
 120 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
 121 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
 122 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
 123 #define LIBNDR_STRING_FLAGS             (0x7FFC)
 124
 125 /* set if relative pointers should *not* be marshalled in reverse order */
 126 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1<<18)
 127
 128 /* set if relative pointers are marshalled in reverse order */
 129 #define LIBNDR_FLAG_RELATIVE_REVERSE    (1<<19)
 130
 131 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
 132 #define LIBNDR_FLAG_REMAINING    (1<<21)
 133 #define LIBNDR_FLAG_ALIGN2       (1<<22)
 134 #define LIBNDR_FLAG_ALIGN4       (1<<23)
 135 #define LIBNDR_FLAG_ALIGN8       (1<<24)
 136
 137 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
 138
 139 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
 140 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
 141
 142 /* used to force a section of IDL to be little-endian */
 143 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
 144
 145 /* used to check if alignment padding is zero */
 146 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
 147
 148 #define LIBNDR_FLAG_NDR64         (1<<29)
 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) (unlikely(((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         NDR_ERR_NDR64
 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 (unlikely((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size)) { \
 225                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
 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 (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {    \
 235                 if (unlikely(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 (unlikely(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 (likely(!(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 (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
 260                 return _status; \
 261         } \
 262 } while (0)
 263
 264 /* if the call fails then free the ndr pointer */
 265 #define NDR_CHECK_FREE(call) do { \
 266         enum ndr_err_code _status; \
 267         _status = call; \
 268         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
 269                 talloc_free(ndr);                \
 270                 return _status; \
 271         } \
 272 } while (0)
 273
 274 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
 275
 276 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
 277         if ( !(flgs) || (ndr->flags & flgs) ) {\
 278                 if (!(mem_ctx)) {\
 279                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
 280                 }\
 281                 ndr->current_mem_ctx = discard_const(mem_ctx);\
 282         }\
 283 } while(0)
 284
 285 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
 286         if (!ndr->current_mem_ctx) {\
 287                 ndr->current_mem_ctx = talloc_new(ndr);\
 288                 if (!ndr->current_mem_ctx) {\
 289                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
 290                 }\
 291         }\
 292 } while(0)
 293
 294 #define NDR_PULL_ALLOC(ndr, s) do { \
 295         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 296         (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
 297         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
 298 } while (0)
 299
 300 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
 301         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 302         (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
 303         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
 304 } while (0)
 305
 306
 307 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 308        (s) = talloc_array(ndr, uint8_t, size); \
 309        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
 310 } while (0)
 311
 312 #define NDR_PUSH_ALLOC(ndr, s) do { \
 313        (s) = talloc_ptrtype(ndr, (s)); \
 314        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
 315 } while (0)
 316
 317 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 318 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 319 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 320 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
 321 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
 322
 323 #include "../libcli/util/error.h"
 324 #include "librpc/gen_ndr/misc.h"
 325
 326 extern const struct ndr_syntax_id ndr_transfer_syntax;
 327 extern const struct ndr_syntax_id ndr64_transfer_syntax;
 328
 329 struct ndr_interface_call {
 330         const char *name;
 331         size_t struct_size;
 332         ndr_push_flags_fn_t ndr_push;
 333         ndr_pull_flags_fn_t ndr_pull;
 334         ndr_print_function_t ndr_print;
 335         bool async;
 336 };
 337
 338 struct ndr_interface_string_array {
 339         uint32_t count;
 340         const char * const *names;
 341 };
 342
 343 struct ndr_interface_table {
 344         const char *name;
 345         struct ndr_syntax_id syntax_id;
 346         const char *helpstring;
 347         uint32_t num_calls;
 348         const struct ndr_interface_call *calls;
 349         const struct ndr_interface_string_array *endpoints;
 350         const struct ndr_interface_string_array *authservices;
 351 };
 352
 353 struct ndr_interface_list {
 354         struct ndr_interface_list *prev, *next;
 355         const struct ndr_interface_table *table;
 356 };
 357
 358 /*********************************************************************
 359  Map an NT error code from a NDR error code.
 360 *********************************************************************/
 361 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
 362 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
 363
 364 /* FIXME: Use represent_as instead */
 365 struct dom_sid;
 366 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 367 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 368 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 369 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 370 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 371 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 372 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
 373 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 374 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 375 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 376 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
 377 void ndr_print_ipv4_addr(struct ndr_print *ndr, const char *name, const struct in_addr *_ip);
 378 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
 379 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
 380 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
 381 enum ndr_err_code ndr_push_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, uint32_t level, ndr_push_flags_fn_t fn);
 382 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
 383 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
 384 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
 385 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
 386 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
 387 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
 388 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
 389 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
 390 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
 391 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
 392 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
 393 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
 394 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
 395 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
 396 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
 397 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
 398 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
 399 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
 400 size_t ndr_align_size(uint32_t offset, size_t n);
 401 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
 402 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
 403 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
 404 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
 405 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
 406 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 407 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 408 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
 409 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 410 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
 411 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
 412 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 413 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
 414                                 ndr_print_function_t fn, const char *name,
 415                                 int flags, void *ptr);
 416 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
 417 enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
 418                                  enum ndr_err_code ndr_err,
 419                                  const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 420 enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
 421                                  enum ndr_err_code ndr_err,
 422                                  const char *format, ...)  PRINTF_ATTRIBUTE(3,4);
 423 enum ndr_err_code ndr_pull_subcontext_start(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_pull_subcontext_end(struct ndr_pull *ndr,
 428                                  struct ndr_pull *subndr,
 429                                  size_t header_size,
 430                                  ssize_t size_is);
 431 enum ndr_err_code ndr_push_subcontext_start(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_push_subcontext_end(struct ndr_push *ndr,
 436                                  struct ndr_push *subndr,
 437                                  size_t header_size,
 438                                  ssize_t size_is);
 439 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
 440                          struct ndr_token_list **list,
 441                          const void *key,
 442                          uint32_t value);
 443 enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list **list, const void *key, uint32_t *v, int(*_cmp_fn)(const void*,const void*), bool _remove_tok);
 444 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v);
 445 uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key);
 446 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
 447 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
 448 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
 449 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
 450 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
 451 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
 452 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
 453 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
 454 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
 455 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p);
 456 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p);
 457 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p);
 458 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
 459 enum ndr_err_code ndr_pull_struct_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
 460 enum ndr_err_code ndr_pull_union_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, uint32_t level, ndr_pull_flags_fn_t fn);
 461 enum ndr_err_code ndr_pull_union_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, uint32_t level, ndr_pull_flags_fn_t fn);
 462
 463 /* from libndr_basic.h */
 464 #define NDR_SCALAR_PROTO(name, type) \
 465 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
 466 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 467 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
 468
 469 #define NDR_BUFFER_PROTO(name, type) \
 470 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
 471 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 472 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
 473
 474 NDR_SCALAR_PROTO(uint8, uint8_t)
 475 NDR_SCALAR_PROTO(int8, int8_t)
 476 NDR_SCALAR_PROTO(uint16, uint16_t)
 477 NDR_SCALAR_PROTO(int16, int16_t)
 478 NDR_SCALAR_PROTO(uint1632, uint16_t)
 479 NDR_SCALAR_PROTO(uint32, uint32_t)
 480 NDR_SCALAR_PROTO(uint3264, uint32_t)
 481 NDR_SCALAR_PROTO(int32, int32_t)
 482 NDR_SCALAR_PROTO(int3264, int32_t)
 483 NDR_SCALAR_PROTO(udlong, uint64_t)
 484 NDR_SCALAR_PROTO(udlongr, uint64_t)
 485 NDR_SCALAR_PROTO(dlong, int64_t)
 486 NDR_SCALAR_PROTO(hyper, uint64_t)
 487 NDR_SCALAR_PROTO(pointer, void *)
 488 NDR_SCALAR_PROTO(time_t, time_t)
 489 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
 490 NDR_SCALAR_PROTO(WERROR, WERROR)
 491 NDR_SCALAR_PROTO(NTTIME, NTTIME)
 492 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
 493 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
 494 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
 495 NDR_SCALAR_PROTO(ipv4address, const char *)
 496 NDR_SCALAR_PROTO(string, const char *)
 497 NDR_SCALAR_PROTO(double, double)
 498
 499 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
 500 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
 501 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
 502 bool policy_handle_empty(struct policy_handle *h);
 503
 504 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
 505 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
 506 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
 507 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
 508 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
 509 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
 510 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
 511 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
 512 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
 513 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
 514 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
 515 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
 516 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
 517 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
 518 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
 519 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
 520 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
 521 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
 522 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
 523 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 524 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 525 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
 526 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
 527 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
 528 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
 529 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
 530
 531 /* strings */
 532 uint32_t ndr_charset_length(const void *var, charset_t chset);
 533 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
 534 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
 535 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
 536 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
 537 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
 538 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
 539 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
 540 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
 541 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);
 542 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);
 543
 544 /* GUIDs */
 545 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
 546 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
 547 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
 548 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
 549 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
 550 NTSTATUS NS_GUID_from_string(const char *s, struct GUID *guid);
 551 struct GUID GUID_zero(void);
 552 bool GUID_all_zero(const struct GUID *u);
 553 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
 554 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 555 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 556 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 557 char *NS_GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 558 struct GUID GUID_random(void);
 559
 560 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
 561 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 562 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
 563 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 564 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
 565 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 566 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
 567 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 568
 569 #endif /* __LIBNDR_H__ */