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