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