librpc/ndr/libndr.h

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