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