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