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