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