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