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 #include "../lib/util/samba_util.h" /* for discard_const */
  31 #include "../lib/util/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         uint32_t relative_highest_offset;
  62         uint32_t relative_base_offset;
  63         uint32_t relative_rap_convert;
  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         uint32_t relative_end_offset;
  87         struct ndr_token_list *relative_base_list;
  88
  89         struct ndr_token_list *switch_list;
  90         struct ndr_token_list *relative_list;
  91         struct ndr_token_list *relative_begin_list;
  92         struct ndr_token_list *nbt_string_list;
  93         struct ndr_token_list *dns_string_list;
  94         struct ndr_token_list *full_ptr_list;
  95
  96         /* this is used to ensure we generate unique reference IDs */
  97         uint32_t ptr_count;
  98 };
  99
 100 /* structure passed to functions that print IDL structures */
 101 struct ndr_print {
 102         uint32_t flags; /* LIBNDR_FLAG_* */
 103         uint32_t depth;
 104         struct ndr_token_list *switch_list;
 105         void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 106         void *private_data;
 107         bool no_newline;
 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_FLAG_STR_RAW8            (1<<13)
 124 #define LIBNDR_STRING_FLAGS             (0x7FFC)
 125
 126 /*
 127  * This lets ndr_pull_subcontext_end() return
 128  * NDR_ERR_UNREAD_BYTES.
 129  */
 130 #define LIBNDR_FLAG_SUBCONTEXT_NO_UNREAD_BYTES (1<<17)
 131
 132 /* set if relative pointers should *not* be marshalled in reverse order */
 133 #define LIBNDR_FLAG_NO_RELATIVE_REVERSE (1<<18)
 134
 135 /* set if relative pointers are marshalled in reverse order */
 136 #define LIBNDR_FLAG_RELATIVE_REVERSE    (1<<19)
 137
 138 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
 139 #define LIBNDR_FLAG_REMAINING    (1<<21)
 140 #define LIBNDR_FLAG_ALIGN2       (1<<22)
 141 #define LIBNDR_FLAG_ALIGN4       (1<<23)
 142 #define LIBNDR_FLAG_ALIGN8       (1<<24)
 143
 144 #define LIBNDR_ALIGN_FLAGS ( 0        | \
 145                 LIBNDR_FLAG_NOALIGN   | \
 146                 LIBNDR_FLAG_REMAINING | \
 147                 LIBNDR_FLAG_ALIGN2    | \
 148                 LIBNDR_FLAG_ALIGN4    | \
 149                 LIBNDR_FLAG_ALIGN8    | \
 150                 0)
 151
 152 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
 153 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
 154
 155 /* used to force a section of IDL to be little-endian */
 156 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
 157
 158 /* used to check if alignment padding is zero */
 159 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
 160
 161 #define LIBNDR_FLAG_NDR64         (1<<29)
 162
 163 /* set if an object uuid will be present */
 164 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
 165
 166 /* set to avoid recursion in ndr_size_*() calculation */
 167 #define LIBNDR_FLAG_NO_NDR_SIZE         (1<<31)
 168
 169 /* useful macro for debugging */
 170 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 171 #define NDR_PRINT_DEBUGC(dbgc_class, type, p) ndr_print_debugc(dbgc_class, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
 172 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
 173 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 174 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
 175 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
 176 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 177
 178 /* useful macro for debugging in strings */
 179 #define NDR_PRINT_STRUCT_STRING(ctx, type, p) ndr_print_struct_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, p)
 180 #define NDR_PRINT_UNION_STRING(ctx, type, level, p) ndr_print_union_string(ctx, (ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
 181 #define NDR_PRINT_FUNCTION_STRING(ctx, type, flags, p) ndr_print_function_string(ctx, (ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 182 #define NDR_PRINT_BOTH_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_BOTH, p)
 183 #define NDR_PRINT_OUT_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_OUT, p)
 184 #define NDR_PRINT_IN_STRING(ctx, type, p) NDR_PRINT_FUNCTION_STRING(ctx, type, NDR_IN | NDR_SET_VALUES, p)
 185
 186 #define NDR_BE(ndr) (unlikely(((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN))
 187
 188 enum ndr_err_code {
 189         NDR_ERR_SUCCESS = 0,
 190         NDR_ERR_ARRAY_SIZE,
 191         NDR_ERR_BAD_SWITCH,
 192         NDR_ERR_OFFSET,
 193         NDR_ERR_RELATIVE,
 194         NDR_ERR_CHARCNV,
 195         NDR_ERR_LENGTH,
 196         NDR_ERR_SUBCONTEXT,
 197         NDR_ERR_COMPRESSION,
 198         NDR_ERR_STRING,
 199         NDR_ERR_VALIDATE,
 200         NDR_ERR_BUFSIZE,
 201         NDR_ERR_ALLOC,
 202         NDR_ERR_RANGE,
 203         NDR_ERR_TOKEN,
 204         NDR_ERR_IPV4ADDRESS,
 205         NDR_ERR_IPV6ADDRESS,
 206         NDR_ERR_INVALID_POINTER,
 207         NDR_ERR_UNREAD_BYTES,
 208         NDR_ERR_NDR64,
 209         NDR_ERR_FLAGS
 210 };
 211
 212 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
 213
 214 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
 215         if (NULL == (x)) { \
 216                 return NDR_ERR_ALLOC; \
 217         } \
 218 } while (0)
 219
 220 enum ndr_compression_alg {
 221         NDR_COMPRESSION_MSZIP   = 2,
 222         NDR_COMPRESSION_XPRESS  = 3
 223 };
 224
 225 /*
 226   flags passed to control parse flow
 227   These are deliberately in a different range to the NDR_IN/NDR_OUT
 228   flags to catch mixups
 229 */
 230 #define NDR_SCALARS    0x100
 231 #define NDR_BUFFERS    0x200
 232
 233 /*
 234   flags passed to ndr_print_*() and ndr pull/push for functions
 235   These are deliberately in a different range to the NDR_SCALARS/NDR_BUFFERS
 236   flags to catch mixups
 237 */
 238 #define NDR_IN         0x10
 239 #define NDR_OUT        0x20
 240 #define NDR_BOTH       0x30
 241 #define NDR_SET_VALUES 0x40
 242
 243
 244 #define NDR_PULL_CHECK_FLAGS(ndr, ndr_flags) do { \
 245         if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) { \
 246                 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid pull struct ndr_flags 0x%x", ndr_flags); \
 247         } \
 248 } while (0)
 249
 250 #define NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags) do { \
 251         if ((ndr_flags) & ~(NDR_SCALARS|NDR_BUFFERS)) \
 252                 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid push struct ndr_flags 0x%x", ndr_flags); \
 253 } while (0)
 254
 255 #define NDR_PULL_CHECK_FN_FLAGS(ndr, flags) do { \
 256         if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) { \
 257                 return ndr_pull_error(ndr, NDR_ERR_FLAGS, "Invalid fn pull flags 0x%x", flags); \
 258         } \
 259 } while (0)
 260
 261 #define NDR_PUSH_CHECK_FN_FLAGS(ndr, flags) do { \
 262         if ((flags) & ~(NDR_BOTH|NDR_SET_VALUES)) \
 263                 return ndr_push_error(ndr, NDR_ERR_FLAGS, "Invalid fn push flags 0x%x", flags); \
 264 } while (0)
 265
 266 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 267         if (unlikely((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size)) { \
 268                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u (%s)", (unsigned)n, __location__); \
 269         } \
 270 } while(0)
 271
 272 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 273
 274 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
 275
 276 #define NDR_PULL_ALIGN(ndr, n) do { \
 277         if (unlikely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {    \
 278                 if (unlikely(ndr->flags & LIBNDR_FLAG_PAD_CHECK)) {     \
 279                         ndr_check_padding(ndr, n); \
 280                 } \
 281                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 282         } \
 283         if (unlikely(ndr->offset > ndr->data_size)) {                   \
 284                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
 285         } \
 286 } while(0)
 287
 288 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
 289
 290 #define NDR_PUSH_ALIGN(ndr, n) do { \
 291         if (likely(!(ndr->flags & LIBNDR_FLAG_NOALIGN))) {      \
 292                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 293                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
 294         } \
 295 } while(0)
 296
 297 /* these are used to make the error checking on each element in libndr
 298    less tedious, hopefully making the code more readable */
 299 #define NDR_CHECK(call) do { \
 300         enum ndr_err_code _status; \
 301         _status = call; \
 302         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
 303                 return _status; \
 304         } \
 305 } while (0)
 306
 307 /* if the call fails then free the ndr pointer */
 308 #define NDR_CHECK_FREE(call) do { \
 309         enum ndr_err_code _status; \
 310         _status = call; \
 311         if (unlikely(!NDR_ERR_CODE_IS_SUCCESS(_status))) {      \
 312                 talloc_free(ndr);                \
 313                 return _status; \
 314         } \
 315 } while (0)
 316
 317 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
 318
 319 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
 320         if ( !(flgs) || (ndr->flags & flgs) ) {\
 321                 if (!(mem_ctx)) {\
 322                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
 323                 }\
 324                 ndr->current_mem_ctx = discard_const(mem_ctx);\
 325         }\
 326 } while(0)
 327
 328 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
 329         if (!ndr->current_mem_ctx) {\
 330                 ndr->current_mem_ctx = talloc_new(ndr);\
 331                 if (!ndr->current_mem_ctx) {\
 332                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
 333                 }\
 334         }\
 335 } while(0)
 336
 337 #define NDR_PULL_ALLOC(ndr, s) do { \
 338         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 339         (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
 340         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
 341 } while (0)
 342
 343 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
 344         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 345         (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
 346         if (unlikely(!(s))) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
 347 } while (0)
 348
 349
 350 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 351        (s) = talloc_array(ndr, uint8_t, size); \
 352        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
 353 } while (0)
 354
 355 #define NDR_PUSH_ALLOC(ndr, s) do { \
 356        (s) = talloc_ptrtype(ndr, (s)); \
 357        if (unlikely(!(s))) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
 358 } while (0)
 359
 360 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 361 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 362 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 363 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
 364 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
 365
 366 #include "../libcli/util/error.h"
 367 #include "librpc/gen_ndr/misc.h"
 368
 369 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr;
 370 extern const struct ndr_syntax_id ndr_transfer_syntax_ndr64;
 371 extern const struct ndr_syntax_id ndr_syntax_id_null;
 372
 373 struct ndr_interface_call_pipe {
 374         const char *name;
 375         const char *chunk_struct_name;
 376         size_t chunk_struct_size;
 377         ndr_push_flags_fn_t ndr_push;
 378         ndr_pull_flags_fn_t ndr_pull;
 379         ndr_print_fn_t ndr_print;
 380 };
 381
 382 struct ndr_interface_call_pipes {
 383         uint32_t num_pipes;
 384         const struct ndr_interface_call_pipe *pipes;
 385 };
 386
 387 struct ndr_interface_call {
 388         const char *name;
 389         size_t struct_size;
 390         ndr_push_flags_fn_t ndr_push;
 391         ndr_pull_flags_fn_t ndr_pull;
 392         ndr_print_function_t ndr_print;
 393         struct ndr_interface_call_pipes in_pipes;
 394         struct ndr_interface_call_pipes out_pipes;
 395 };
 396
 397 struct ndr_interface_string_array {
 398         uint32_t count;
 399         const char * const *names;
 400 };
 401
 402 struct ndr_interface_table {
 403         const char *name;
 404         struct ndr_syntax_id syntax_id;
 405         const char *helpstring;
 406         uint32_t num_calls;
 407         const struct ndr_interface_call *calls;
 408         const struct ndr_interface_string_array *endpoints;
 409         const struct ndr_interface_string_array *authservices;
 410 };
 411
 412 struct ndr_interface_list {
 413         struct ndr_interface_list *prev, *next;
 414         const struct ndr_interface_table *table;
 415 };
 416
 417 struct sockaddr_storage;
 418
 419 /*********************************************************************
 420  Map an NT error code from a NDR error code.
 421 *********************************************************************/
 422 NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err);
 423 int ndr_map_error2errno(enum ndr_err_code ndr_err);
 424 const char *ndr_map_error2string(enum ndr_err_code ndr_err);
 425 #define ndr_errstr ndr_map_error2string
 426
 427 /* FIXME: Use represent_as instead */
 428 struct dom_sid;
 429 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 430 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 431 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 432 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 433 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 434 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 435 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
 436 enum ndr_err_code ndr_push_dom_sid0(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 437 enum ndr_err_code ndr_pull_dom_sid0(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 438 void ndr_print_dom_sid0(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 439 size_t ndr_size_dom_sid0(const struct dom_sid *sid, int flags);
 440 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
 441 void ndr_print_sockaddr_storage(struct ndr_print *ndr, const char *name, const struct sockaddr_storage *ss);
 442 bool ndr_syntax_id_equal(const struct ndr_syntax_id *i1, const struct ndr_syntax_id *i2);
 443 enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, const void *p, ndr_push_flags_fn_t fn);
 444 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);
 445 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push);
 446 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push);
 447 uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr);
 448 void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset);
 449 enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset);
 450 enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p);
 451 enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p);
 452 enum ndr_err_code ndr_push_short_relative_ptr1(struct ndr_push *ndr, const void *p);
 453 enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p);
 454 enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p);
 455 enum ndr_err_code ndr_push_short_relative_ptr2(struct ndr_push *ndr, const void *p);
 456 uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr);
 457 void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset);
 458 enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset);
 459 enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p);
 460 enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset);
 461 enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p);
 462 enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v);
 463 size_t ndr_align_size(uint32_t offset, size_t n);
 464 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx);
 465 enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size);
 466 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx);
 467 DATA_BLOB ndr_push_blob(struct ndr_push *ndr);
 468 enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size);
 469 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 470 void ndr_print_debugc_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 471 void ndr_print_printf_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 472 void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...) PRINTF_ATTRIBUTE(2,3);
 473 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr);
 474 void ndr_print_debugc(int dbgc_class, ndr_print_fn_t fn, const char *name, void *ptr);
 475 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 476 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr);
 477 char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr);
 478 char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr);
 479 char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
 480                                 ndr_print_function_t fn, const char *name,
 481                                 int flags, void *ptr);
 482 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags);
 483 enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
 484                                  enum ndr_err_code ndr_err,
 485                                  const char *format, ...) PRINTF_ATTRIBUTE(3,4);
 486 enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
 487                                  enum ndr_err_code ndr_err,
 488                                  const char *format, ...)  PRINTF_ATTRIBUTE(3,4);
 489 enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
 490                                    struct ndr_pull **_subndr,
 491                                    size_t header_size,
 492                                    ssize_t size_is);
 493 enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
 494                                  struct ndr_pull *subndr,
 495                                  size_t header_size,
 496                                  ssize_t size_is);
 497 enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
 498                                    struct ndr_push **_subndr,
 499                                    size_t header_size,
 500                                    ssize_t size_is);
 501 enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
 502                                  struct ndr_push *subndr,
 503                                  size_t header_size,
 504                                  ssize_t size_is);
 505 enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
 506                          struct ndr_token_list **list,
 507                          const void *key,
 508                          uint32_t value);
 509 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);
 510 enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v);
 511 uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key);
 512 enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p);
 513 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p);
 514 enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size);
 515 enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p);
 516 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p);
 517 enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length);
 518 enum ndr_err_code ndr_push_pipe_chunk_trailer(struct ndr_push *ndr, int ndr_flags, uint32_t count);
 519 enum ndr_err_code ndr_check_pipe_chunk_trailer(struct ndr_pull *ndr, int ndr_flags, uint32_t count);
 520 enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val);
 521 enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val);
 522 enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val);
 523 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p);
 524 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p);
 525 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p);
 526 enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p, ndr_pull_flags_fn_t fn);
 527 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);
 528 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);
 529 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);
 530
 531 /* from libndr_basic.h */
 532 #define NDR_SCALAR_PROTO(name, type) \
 533 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, type v); \
 534 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 535 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, type v);
 536
 537 #define NDR_BUFFER_PROTO(name, type) \
 538 enum ndr_err_code ndr_push_ ## name(struct ndr_push *ndr, int ndr_flags, const type *v); \
 539 enum ndr_err_code ndr_pull_ ## name(struct ndr_pull *ndr, int ndr_flags, type *v); \
 540 void ndr_print_ ## name(struct ndr_print *ndr, const char *var_name, const type *v);
 541
 542 NDR_SCALAR_PROTO(uint8, uint8_t)
 543 NDR_SCALAR_PROTO(int8, int8_t)
 544 NDR_SCALAR_PROTO(uint16, uint16_t)
 545 NDR_SCALAR_PROTO(int16, int16_t)
 546 NDR_SCALAR_PROTO(uint1632, uint16_t)
 547 NDR_SCALAR_PROTO(uint32, uint32_t)
 548 NDR_SCALAR_PROTO(uint3264, uint32_t)
 549 NDR_SCALAR_PROTO(int32, int32_t)
 550 NDR_SCALAR_PROTO(int3264, int32_t)
 551 NDR_SCALAR_PROTO(udlong, uint64_t)
 552 NDR_SCALAR_PROTO(udlongr, uint64_t)
 553 NDR_SCALAR_PROTO(dlong, int64_t)
 554 NDR_SCALAR_PROTO(hyper, uint64_t)
 555 NDR_SCALAR_PROTO(pointer, void *)
 556 NDR_SCALAR_PROTO(time_t, time_t)
 557 NDR_SCALAR_PROTO(uid_t, uid_t)
 558 NDR_SCALAR_PROTO(gid_t, gid_t)
 559 NDR_SCALAR_PROTO(NTSTATUS, NTSTATUS)
 560 NDR_SCALAR_PROTO(WERROR, WERROR)
 561 NDR_SCALAR_PROTO(NTTIME, NTTIME)
 562 NDR_SCALAR_PROTO(NTTIME_1sec, NTTIME)
 563 NDR_SCALAR_PROTO(NTTIME_hyper, NTTIME)
 564 NDR_SCALAR_PROTO(DATA_BLOB, DATA_BLOB)
 565 NDR_SCALAR_PROTO(ipv4address, const char *)
 566 NDR_SCALAR_PROTO(ipv6address, const char *)
 567 NDR_SCALAR_PROTO(string, const char *)
 568 NDR_SCALAR_PROTO(double, double)
 569
 570 enum ndr_err_code ndr_pull_policy_handle(struct ndr_pull *ndr, int ndr_flags, struct policy_handle *r);
 571 enum ndr_err_code ndr_push_policy_handle(struct ndr_push *ndr, int ndr_flags, const struct policy_handle *r);
 572 void ndr_print_policy_handle(struct ndr_print *ndr, const char *name, const struct policy_handle *r);
 573 bool ndr_policy_handle_empty(const struct policy_handle *h);
 574 #define is_valid_policy_hnd(hnd) (!ndr_policy_handle_empty(hnd))
 575 bool ndr_policy_handle_equal(const struct policy_handle *hnd1,
 576                          const struct policy_handle *hnd2);
 577
 578 void ndr_check_padding(struct ndr_pull *ndr, size_t n);
 579 enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v);
 580 enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v);
 581 enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n);
 582 enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n);
 583 enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size);
 584 enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size);
 585 enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size);
 586 enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size);
 587 enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size);
 588 enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size);
 589 enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n);
 590 enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n);
 591 enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n);
 592 enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p);
 593 enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p);
 594 enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr);
 595 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type);
 596 void ndr_print_null(struct ndr_print *ndr);
 597 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type, const char *val, uint32_t value);
 598 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 599 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value);
 600 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p);
 601 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type);
 602 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level);
 603 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name, const uint8_t *data, uint32_t count);
 604 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags);
 605
 606 /* strings */
 607 uint32_t ndr_charset_length(const void *var, charset_t chset);
 608 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s);
 609 uint32_t ndr_size_string(int ret, const char * const* string, int flags);
 610 enum ndr_err_code ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a);
 611 enum ndr_err_code ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a);
 612 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a);
 613 size_t ndr_size_string_array(const char **a, uint32_t count, int flags);
 614 uint32_t ndr_string_length(const void *_var, uint32_t element_size);
 615 enum ndr_err_code ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size);
 616 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);
 617 enum ndr_err_code ndr_pull_charset_to_null(struct ndr_pull *ndr, int ndr_flags, const char **var, uint32_t length, uint8_t byte_mul, charset_t chset);
 618 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);
 619
 620 /* GUIDs */
 621 bool GUID_equal(const struct GUID *u1, const struct GUID *u2);
 622 NTSTATUS GUID_to_ndr_blob(const struct GUID *guid, TALLOC_CTX *mem_ctx, DATA_BLOB *b);
 623 NTSTATUS GUID_from_ndr_blob(const DATA_BLOB *b, struct GUID *guid);
 624 NTSTATUS GUID_from_data_blob(const DATA_BLOB *s, struct GUID *guid);
 625 NTSTATUS GUID_from_string(const char *s, struct GUID *guid);
 626 struct GUID GUID_zero(void);
 627 bool GUID_all_zero(const struct GUID *u);
 628 int GUID_compare(const struct GUID *u1, const struct GUID *u2);
 629 char *GUID_string(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 630 char *GUID_string2(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 631 char *GUID_hexstring(TALLOC_CTX *mem_ctx, const struct GUID *guid);
 632 struct GUID GUID_random(void);
 633
 634 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v);
 635 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 636 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v);
 637 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v);
 638 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v);
 639 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 640 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v);
 641 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v);
 642
 643 _PUBLIC_ void ndr_print_bool(struct ndr_print *ndr, const char *name, const bool b);
 644
 645 _PUBLIC_ enum ndr_err_code ndr_push_timespec(struct ndr_push *ndr,
 646                                              int ndr_flags,
 647                                              const struct timespec *t);
 648 _PUBLIC_ enum ndr_err_code ndr_pull_timespec(struct ndr_pull *ndr,
 649                                              int ndr_flags,
 650                                              struct timespec *t);
 651 _PUBLIC_ void ndr_print_timespec(struct ndr_print *ndr, const char *name,
 652                                  const struct timespec *t);
 653
 654 _PUBLIC_ enum ndr_err_code ndr_push_timeval(struct ndr_push *ndr,
 655                                             int ndr_flags,
 656                                             const struct timeval *t);
 657 _PUBLIC_ enum ndr_err_code ndr_pull_timeval(struct ndr_pull *ndr,
 658                                             int ndr_flags,
 659                                             struct timeval *t);
 660 _PUBLIC_ void ndr_print_timeval(struct ndr_print *ndr, const char *name,
 661                                 const struct timeval *t);
 662
 663
 664
 665 #endif /* __LIBNDR_H__ */