librpc/ndr/libndr.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    rpc interface definitions
   4
   5    Copyright (C) Andrew Tridgell 2003
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 /* This is a public header file that is installed as part of Samba.
  22  * If you remove any functions or change their signature, update
  23  * the so version number. */
  24
  25 #ifndef __LIBNDR_H__
  26 #define __LIBNDR_H__
  27
  28 #include <talloc.h>
  29 #include <sys/time.h>
  30 #if _SAMBA_BUILD_ == 4
  31 #include "../lib/util/util.h" /* for discard_const */
  32 #include "../lib/util/charset/charset.h"
  33 #endif
  34
  35 /*
  36   this provides definitions for the libcli/rpc/ MSRPC library
  37 */
  38
  39
  40 /*
  41   this is used by the token store/retrieve code
  42 */
  43 struct ndr_token_list {
  44         struct ndr_token_list *next, *prev;
  45         const void *key;
  46         uint32_t value;
  47 };
  48
  49 /* this is the base structure passed to routines that
  50    parse MSRPC formatted data
  51
  52    note that in Samba4 we use separate routines and structures for
  53    MSRPC marshalling and unmarshalling. Also note that these routines
  54    are being kept deliberately very simple, and are not tied to a
  55    particular transport
  56 */
  57 struct ndr_pull {
  58         uint32_t flags; /* LIBNDR_FLAG_* */
  59         uint8_t *data;
  60         uint32_t data_size;
  61         uint32_t offset;
  62
  63         uint32_t relative_highest_offset;
  64         uint32_t relative_base_offset;
  65         uint32_t relative_rap_convert;
  66         struct ndr_token_list *relative_base_list;
  67
  68         struct ndr_token_list *relative_list;
  69         struct ndr_token_list *array_size_list;
  70         struct ndr_token_list *array_length_list;
  71         struct ndr_token_list *switch_list;
  72
  73         TALLOC_CTX *current_mem_ctx;
  74
  75         /* this is used to ensure we generate unique reference IDs
  76            between request and reply */
  77         uint32_t ptr_count;
  78 };
  79
  80 /* structure passed to functions that generate NDR formatted data */
  81 struct ndr_push {
  82         uint32_t flags; /* LIBNDR_FLAG_* */
  83         uint8_t *data;
  84         uint32_t alloc_size;
  85         uint32_t offset;
  86
  87         uint32_t relative_base_offset;
  88         uint32_t relative_end_offset;
  89         struct ndr_token_list *relative_base_list;
  90
  91         struct ndr_token_list *switch_list;
  92         struct ndr_token_list *relative_list;
  93         struct ndr_token_list *relative_begin_list;
  94         struct ndr_token_list *nbt_string_list;
  95         struct ndr_token_list *dns_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
 102 /* structure passed to functions that print IDL structures */
 103 struct ndr_print {
 104         uint32_t flags; /* LIBNDR_FLAG_* */
 105         uint32_t depth;
 106         struct ndr_token_list *switch_list;
 107         void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 108         void *private_data;
 109         bool no_newline;
 110 };
 111
 112 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
 113 #define LIBNDR_FLAG_NOALIGN    (1<<1)
 114
 115 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
 116 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
 117 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
 118 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
 119 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
 120 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
 121 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
 122 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
 123 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
 124 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
 125 #define LIBNDR_FLAG_STR_RAW8            (1<<13)
 126 #define LIBNDR_STRING_FLAGS             (0x7FFC)
 127
 128 /* set if relative pointers should *not* be marshalled in reverse order */
 129 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1<<18)
 130
 131 /* set if relative pointers are marshalled in reverse order */
 132 #define LIBNDR_FLAG_RELATIVE_REVERSE    (1<<19)
 133
 134 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
 135 #define LIBNDR_FLAG_REMAINING    (1<<21)
 136 #define LIBNDR_FLAG_ALIGN2       (1<<22)
 137 #define LIBNDR_FLAG_ALIGN4       (1<<23)
 138 #define LIBNDR_FLAG_ALIGN8       (1<<24)
 139
 140 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
 141
 142 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
 143 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
 144
 145 /* used to force a section of IDL to be little-endian */
 146 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
 147
 148 /* used to check if alignment padding is zero */
 149 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
 150
 151 #define LIBNDR_FLAG_NDR64         (1<<29)
 152
 153 /* set if an object uuid will be present */
 154 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
 155
 156 /* set to avoid recursion in ndr_size_*() calculation */
 157 #define LIBNDR_FLAG_NO_NDR_SIZE         (1<<31)
 158
 159 /* useful macro for debugging */
 160 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 161 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
 162 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 163 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
 164 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
 165 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 166
 167 /* useful macro for debugging in strings */
 168 #define NDR_PRINT_STRUCT_STRING(ctx, type, p) ndr_print_struct_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
 169 #define NDR_PRINT_UNION_STRING(ctx, type, level, p) ndr_print_union_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
 170 #define NDR_PRINT_FUNCTION_STRING(ctx, type, flags, p) ndr_print_function_string(ctx, (ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 171 #define NDR_PRINT_BOTH_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_BOTH, p)
 172 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
 173 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
 174
 175 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
 176
 177 enum ndr_err_code {
 178         NDR_ERR_SUCCESS = 0,
 179         NDR_ERR_ARRAY_SIZE,
 180         NDR_ERR_BAD_SWITCH,
 181         NDR_ERR_OFFSET,
 182         NDR_ERR_RELATIVE,
 183         NDR_ERR_CHARCNV,
 184         NDR_ERR_LENGTH,
 185         NDR_ERR_SUBCONTEXT,
 186         NDR_ERR_COMPRESSION,
 187         NDR_ERR_STRING,
 188         NDR_ERR_VALIDATE,
 189         NDR_ERR_BUFSIZE,
 190         NDR_ERR_ALLOC,
 191         NDR_ERR_RANGE,
 192         NDR_ERR_TOKEN,
 193         NDR_ERR_IPV4ADDRESS,
 194         NDR_ERR_IPV6ADDRESS,
 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 extern const struct ndr_syntax_id null_ndr_syntax_id;
 333
 334 struct ndr_interface_call_pipe {
 335         const char *name;
 336         const char *chunk_struct_name;
 337         size_t chunk_struct_size;
 338         ndr_push_flags_fn_t ndr_push;
 339         ndr_pull_flags_fn_t ndr_pull;
 340         ndr_print_fn_t ndr_print;
 341 };
 342
 343 struct ndr_interface_call_pipes {
 344         uint32_t num_pipes;
 345         const struct ndr_interface_call_pipe *pipes;
 346 };
 347
 348 struct ndr_interface_call {
 349         const char *name;
 350         size_t struct_size;
 351         ndr_push_flags_fn_t ndr_push;
 352         ndr_pull_flags_fn_t ndr_pull;
 353         ndr_print_function_t ndr_print;
 354         struct ndr_interface_call_pipes in_pipes;
 355         struct ndr_interface_call_pipes out_pipes;
 356 };
 357
 358 struct ndr_interface_string_array {
 359         uint32_t count;
 360         const char * const *names;
 361 };
 362
 363 struct ndr_interface_table {
 364         const char *name;
 365         struct ndr_syntax_id syntax_id;
 366         const char *helpstring;
 367         uint32_t num_calls;
 368         const struct ndr_interface_call *calls;
 369         const struct ndr_interface_string_array *endpoints;
 370         const struct ndr_interface_string_array *authservices;
 371 };
 372
 373 struct ndr_interface_list {
 374         struct ndr_interface_list *prev, *next;
 375         const struct ndr_interface_table *table;
 376 };
 377
 378 struct sockaddr_storage;
 379
 380 /*********************************************************************
 381  Map an NT error code from a NDR error code.
 382 *********************************************************************/
 383 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
 384 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
 385 #define ndr_errstr ndr_map_error2string
 386
 387 /* FIXME: Use represent_as instead */
 388 struct dom_sid;
 389 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 390 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 391 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 392 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 393 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 394 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 395 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
 396 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 397 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 398 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 399 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
 400 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
 401 void ndr_print_sockaddr_storage(struct ndr_print *ndr, const char *name, const struct sockaddr_storage *ss);
 402 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
 403 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
 404 enum ndr_err_code ndr_push_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, uint32_t level, ndr_push_flags_fn_t fn);
 405 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
 406 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
 407 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
 408 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
 409 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
 410 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
 411 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
 412 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
 413 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
 414 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
 415 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
 416 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
 417 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
 418 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
 419 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
 420 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
 421 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
 422 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
 423 size_t ndr_align_size(uint32_t offset, size_t n);
 424 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
 425 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
 426 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
 427 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
 428 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
 429 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 430 void ndr_print_printf_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 431 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 432 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
 433 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 434 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
 435 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
 436 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 437 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
 438                                 ndr_print_function_t fn, const char *name,
 439                                 int flags, void *ptr);
 440 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
 441 enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
 442                                  enum ndr_err_code ndr_err,
 443                                  const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 444 enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
 445                                  enum ndr_err_code ndr_err,
 446                                  const char *format, ...)  PRINTF_ATTRIBUTE(3,4);
 447 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
 448                                    struct ndr_pull **_subndr,
 449                                    size_t header_size,
 450                                    ssize_t size_is);
 451 enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
 452                                  struct ndr_pull *subndr,
 453                                  size_t header_size,
 454                                  ssize_t size_is);
 455 enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
 456                                    struct ndr_push **_subndr,
 457                                    size_t header_size,
 458                                    ssize_t size_is);
 459 enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
 460                                  struct ndr_push *subndr,
 461                                  size_t header_size,
 462                                  ssize_t size_is);
 463 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
 464                          struct ndr_token_list **list,
 465                          const void *key,
 466                          uint32_t value);
 467 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);
 468 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v);
 469 uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key);
 470 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
 471 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
 472 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
 473 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
 474 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
 475 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
 476 enum ndr_err_code ndr_push_pipe_chunk_trailer(struct ndr_push *ndr, int ndr_flags, uint32_t count);
 477 enum ndr_err_code ndr_check_pipe_chunk_trailer(struct ndr_pull *ndr, int ndr_flags, uint32_t count);
 478 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
 479 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
 480 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
 481 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p);
 482 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p);
 483 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p);
 484 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
 485 enum ndr_err_code ndr_pull_struct_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
 486 enum ndr_err_code ndr_pull_union_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, uint32_t level, ndr_pull_flags_fn_t fn);
 487 enum ndr_err_code ndr_pull_union_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, uint32_t level, ndr_pull_flags_fn_t fn);
 488
 489 /* from libndr_basic.h */
 490 #define NDR_SCALAR_PROTO(name, type) \
 491 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
 492 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 493 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
 494
 495 #define NDR_BUFFER_PROTO(name, type) \
 496 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
 497 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 498 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
 499
 500 NDR_SCALAR_PROTO(uint8, uint8_t)
 501 NDR_SCALAR_PROTO(int8, int8_t)
 502 NDR_SCALAR_PROTO(uint16, uint16_t)
 503 NDR_SCALAR_PROTO(int16, int16_t)
 504 NDR_SCALAR_PROTO(uint1632, uint16_t)
 505 NDR_SCALAR_PROTO(uint32, uint32_t)
 506 NDR_SCALAR_PROTO(uint3264, uint32_t)
 507 NDR_SCALAR_PROTO(int32, int32_t)
 508 NDR_SCALAR_PROTO(int3264, int32_t)
 509 NDR_SCALAR_PROTO(udlong, uint64_t)
 510 NDR_SCALAR_PROTO(udlongr, uint64_t)
 511 NDR_SCALAR_PROTO(dlong, int64_t)
 512 NDR_SCALAR_PROTO(hyper, uint64_t)
 513 NDR_SCALAR_PROTO(pointer, void *)
 514 NDR_SCALAR_PROTO(time_t, time_t)
 515 NDR_SCALAR_PROTO(uid_t, uid_t)
 516 NDR_SCALAR_PROTO(gid_t, gid_t)
 517 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
 518 NDR_SCALAR_PROTO(WERROR, WERROR)
 519 NDR_SCALAR_PROTO(NTTIME, NTTIME)
 520 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
 521 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
 522 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
 523 NDR_SCALAR_PROTO(ipv4address, const char *)
 524 NDR_SCALAR_PROTO(ipv6address, const char *)
 525 NDR_SCALAR_PROTO(string, const char *)
 526 NDR_SCALAR_PROTO(double, double)
 527
 528 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
 529 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
 530 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
 531 bool policy_handle_empty(const struct policy_handle *h);
 532 bool is_valid_policy_hnd(const struct policy_handle *hnd);
 533 bool policy_handle_equal(const struct policy_handle *hnd1,
 534                          const struct policy_handle *hnd2);
 535
 536 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
 537 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
 538 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
 539 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
 540 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
 541 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
 542 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
 543 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
 544 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
 545 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
 546 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
 547 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
 548 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
 549 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
 550 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
 551 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
 552 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
 553 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
 554 void ndr_print_null(struct ndr_print *ndr);
 555 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
 556 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 557 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 558 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
 559 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
 560 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
 561 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
 562 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
 563
 564 /* strings */
 565 uint32_t ndr_charset_length(const void *var, charset_t chset);
 566 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
 567 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
 568 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
 569 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
 570 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
 571 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
 572 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
 573 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
 574 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);
 575 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);
 576
 577 /* GUIDs */
 578 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
 579 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
 580 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
 581 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
 582 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
 583 NTSTATUS NS_GUID_from_string(const char *s, struct GUID *guid);
 584 struct GUID GUID_zero(void);
 585 bool GUID_all_zero(const struct GUID *u);
 586 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
 587 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 588 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 589 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 590 char *NS_GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 591 struct GUID GUID_random(void);
 592
 593 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
 594 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 595 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
 596 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 597 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
 598 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 599 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
 600 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 601
 602 _PUBLIC_ void ndr_print_bool(struct ndr_print *ndr, const char *name, const bool b);
 603
 604 #endif /* __LIBNDR_H__ */