librpc/ndr/libndr.h

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