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