source/librpc/ndr/libndr.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    rpc interface definitions
   4    Copyright (C) Andrew Tridgell 2003
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __LIBNDR_H__
  21 #define __LIBNDR_H__
  22
  23 #include <talloc.h>
  24 #include "lib/util/util.h" /* for discard_const */
  25 #include "lib/charset/charset.h"
  26
  27 /*
  28   this provides definitions for the libcli/rpc/ MSRPC library
  29 */
  30
  31
  32 /*
  33   this is used by the token store/retrieve code
  34 */
  35 struct ndr_token_list {
  36         struct ndr_token_list *next, *prev;
  37         const void *key;
  38         uint32_t value;
  39 };
  40
  41 /* this is the base structure passed to routines that
  42    parse MSRPC formatted data
  43
  44    note that in Samba4 we use separate routines and structures for
  45    MSRPC marshalling and unmarshalling. Also note that these routines
  46    are being kept deliberately very simple, and are not tied to a
  47    particular transport
  48 */
  49 struct ndr_pull {
  50         uint32_t flags; /* LIBNDR_FLAG_* */
  51         uint8_t *data;
  52         uint32_t data_size;
  53         uint32_t offset;
  54
  55         struct smb_iconv_convenience *iconv_convenience;
  56
  57         uint32_t relative_base_offset;
  58         struct ndr_token_list *relative_base_list;
  59
  60         struct ndr_token_list *relative_list;
  61         struct ndr_token_list *array_size_list;
  62         struct ndr_token_list *array_length_list;
  63         struct ndr_token_list *switch_list;
  64
  65         TALLOC_CTX *current_mem_ctx;
  66
  67         /* this is used to ensure we generate unique reference IDs
  68            between request and reply */
  69         uint32_t ptr_count;
  70 };
  71
  72 /* structure passed to functions that generate NDR formatted data */
  73 struct ndr_push {
  74         uint32_t flags; /* LIBNDR_FLAG_* */
  75         uint8_t *data;
  76         uint32_t alloc_size;
  77         uint32_t offset;
  78
  79         uint32_t relative_base_offset;
  80         struct ndr_token_list *relative_base_list;
  81
  82         struct ndr_token_list *switch_list;
  83         struct ndr_token_list *relative_list;
  84         struct ndr_token_list *nbt_string_list;
  85         struct ndr_token_list *full_ptr_list;
  86
  87         /* this is used to ensure we generate unique reference IDs */
  88         uint32_t ptr_count;
  89
  90         struct smb_iconv_convenience *iconv_convenience;
  91 };
  92
  93 /* structure passed to functions that print IDL structures */
  94 struct ndr_print {
  95         uint32_t flags; /* LIBNDR_FLAG_* */
  96         uint32_t depth;
  97         struct ndr_token_list *switch_list;
  98         void (*print)(struct ndr_print *, const char *, ...) PRINTF_ATTRIBUTE(2,3);
  99         void *private_data;
 100 };
 101
 102 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
 103 #define LIBNDR_FLAG_NOALIGN    (1<<1)
 104
 105 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
 106 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
 107 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
 108 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
 109 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
 110 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
 111 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
 112 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
 113 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
 114 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
 115 #define LIBNDR_STRING_FLAGS             (0x7FFC)
 116
 117
 118 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
 119 #define LIBNDR_FLAG_REMAINING    (1<<21)
 120 #define LIBNDR_FLAG_ALIGN2       (1<<22)
 121 #define LIBNDR_FLAG_ALIGN4       (1<<23)
 122 #define LIBNDR_FLAG_ALIGN8       (1<<24)
 123
 124 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
 125
 126 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
 127 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
 128
 129 /* used to force a section of IDL to be little-endian */
 130 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
 131
 132 /* used to check if alignment padding is zero */
 133 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
 134
 135 /* set if an object uuid will be present */
 136 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
 137
 138 /* set to avoid recursion in ndr_size_*() calculation */
 139 #define LIBNDR_FLAG_NO_NDR_SIZE         (1<<31)
 140
 141 /* useful macro for debugging */
 142 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 143 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_fn_t)ndr_print_ ##type, #p, level, p)
 144 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 145 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
 146 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
 147 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 148
 149 #define NDR_BE(ndr) (((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN)
 150
 151 enum ndr_err_code {
 152         NDR_ERR_SUCCESS = 0,
 153         NDR_ERR_ARRAY_SIZE,
 154         NDR_ERR_BAD_SWITCH,
 155         NDR_ERR_OFFSET,
 156         NDR_ERR_RELATIVE,
 157         NDR_ERR_CHARCNV,
 158         NDR_ERR_LENGTH,
 159         NDR_ERR_SUBCONTEXT,
 160         NDR_ERR_COMPRESSION,
 161         NDR_ERR_STRING,
 162         NDR_ERR_VALIDATE,
 163         NDR_ERR_BUFSIZE,
 164         NDR_ERR_ALLOC,
 165         NDR_ERR_RANGE,
 166         NDR_ERR_TOKEN,
 167         NDR_ERR_IPV4ADDRESS,
 168         NDR_ERR_INVALID_POINTER,
 169         NDR_ERR_UNREAD_BYTES
 170 };
 171
 172 #define NDR_ERR_CODE_IS_SUCCESS(x) (x == NDR_ERR_SUCCESS)
 173
 174 #define NDR_ERR_HAVE_NO_MEMORY(x) do { \
 175         if (NULL == (x)) { \
 176                 return NDR_ERR_ALLOC; \
 177         } \
 178 } while (0)
 179
 180 enum ndr_compression_alg {
 181         NDR_COMPRESSION_MSZIP   = 2,
 182         NDR_COMPRESSION_XPRESS  = 3
 183 };
 184
 185 /*
 186   flags passed to control parse flow
 187 */
 188 #define NDR_SCALARS 1
 189 #define NDR_BUFFERS 2
 190
 191 /*
 192   flags passed to ndr_print_*()
 193 */
 194 #define NDR_IN 1
 195 #define NDR_OUT 2
 196 #define NDR_BOTH 3
 197 #define NDR_SET_VALUES 4
 198
 199 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 200         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
 201                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", (unsigned)n); \
 202         } \
 203 } while(0)
 204
 205 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 206
 207 #define NDR_ROUND(size, n) (((size)+((n)-1)) & ~((n)-1))
 208
 209 #define NDR_PULL_ALIGN(ndr, n) do { \
 210         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 211                 if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
 212                         ndr_check_padding(ndr, n); \
 213                 } \
 214                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 215         } \
 216         if (ndr->offset > ndr->data_size) { \
 217                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", (unsigned)n); \
 218         } \
 219 } while(0)
 220
 221 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, n))
 222
 223 #define NDR_PUSH_ALIGN(ndr, n) do { \
 224         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 225                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 226                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
 227         } \
 228 } while(0)
 229
 230 /* these are used to make the error checking on each element in libndr
 231    less tedious, hopefully making the code more readable */
 232 #define NDR_CHECK(call) do { \
 233         enum ndr_err_code _status; \
 234         _status = call; \
 235         if (!NDR_ERR_CODE_IS_SUCCESS(_status)) { \
 236                 return _status; \
 237         } \
 238 } while (0)
 239
 240 #define NDR_PULL_GET_MEM_CTX(ndr) (ndr->current_mem_ctx)
 241
 242 #define NDR_PULL_SET_MEM_CTX(ndr, mem_ctx, flgs) do {\
 243         if ( !(flgs) || (ndr->flags & flgs) ) {\
 244                 if (!(mem_ctx)) {\
 245                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "NDR_PULL_SET_MEM_CTX(NULL): %s\n", __location__); \
 246                 }\
 247                 ndr->current_mem_ctx = discard_const(mem_ctx);\
 248         }\
 249 } while(0)
 250
 251 #define _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr) do {\
 252         if (!ndr->current_mem_ctx) {\
 253                 ndr->current_mem_ctx = talloc_new(ndr);\
 254                 if (!ndr->current_mem_ctx) {\
 255                         return ndr_pull_error(ndr, NDR_ERR_ALLOC, "_NDR_PULL_FIX_CURRENT_MEM_CTX() failed: %s\n", __location__); \
 256                 }\
 257         }\
 258 } while(0)
 259
 260 #define NDR_PULL_ALLOC(ndr, s) do { \
 261         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 262         (s) = talloc_ptrtype(ndr->current_mem_ctx, (s)); \
 263         if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %s failed: %s\n", # s, __location__); \
 264 } while (0)
 265
 266 #define NDR_PULL_ALLOC_N(ndr, s, n) do { \
 267         _NDR_PULL_FIX_CURRENT_MEM_CTX(ndr);\
 268         (s) = talloc_array_ptrtype(ndr->current_mem_ctx, (s), n); \
 269         if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %s failed: %s\n", (unsigned)n, # s, __location__); \
 270 } while (0)
 271
 272
 273 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 274        (s) = talloc_array(ndr, uint8_t, size); \
 275        if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed: %s\n", (unsigned)size, __location__); \
 276 } while (0)
 277
 278 #define NDR_PUSH_ALLOC(ndr, s) do { \
 279        (s) = talloc_ptrtype(ndr, (s)); \
 280        if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %s failed: %s\n", # s, __location__); \
 281 } while (0)
 282
 283 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 284 typedef enum ndr_err_code (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 285 typedef enum ndr_err_code (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 286 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, const void *);
 287 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, const void *);
 288
 289 #include "libcli/util/error.h"
 290 #include "librpc/gen_ndr/ndr_misc.h"
 291 #include "librpc/ndr/libndr_proto.h"
 292
 293 extern const struct ndr_syntax_id ndr_transfer_syntax;
 294 extern const struct ndr_syntax_id ndr64_transfer_syntax;
 295
 296 struct ndr_interface_call {
 297         const char *name;
 298         size_t struct_size;
 299         ndr_push_flags_fn_t ndr_push;
 300         ndr_pull_flags_fn_t ndr_pull;
 301         ndr_print_function_t ndr_print;
 302         bool async;
 303 };
 304
 305 struct ndr_interface_string_array {
 306         uint32_t count;
 307         const char * const *names;
 308 };
 309
 310 struct ndr_interface_table {
 311         const char *name;
 312         struct ndr_syntax_id syntax_id;
 313         const char *helpstring;
 314         uint32_t num_calls;
 315         const struct ndr_interface_call *calls;
 316         const struct ndr_interface_string_array *endpoints;
 317         const struct ndr_interface_string_array *authservices;
 318 };
 319
 320 struct ndr_interface_list {
 321         struct ndr_interface_list *prev, *next;
 322         const struct ndr_interface_table *table;
 323 };
 324
 325 /* FIXME: Use represent_as instead */
 326 struct dom_sid;
 327 enum ndr_err_code ndr_push_dom_sid2(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 328 enum ndr_err_code ndr_pull_dom_sid2(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 329 void ndr_print_dom_sid2(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 330 enum ndr_err_code ndr_push_dom_sid28(struct ndr_push *ndr, int ndr_flags, const struct dom_sid *sid);
 331 enum ndr_err_code ndr_pull_dom_sid28(struct ndr_pull *ndr, int ndr_flags, struct dom_sid *sid);
 332 void ndr_print_dom_sid28(struct ndr_print *ndr, const char *name, const struct dom_sid *sid);
 333 size_t ndr_size_dom_sid28(const struct dom_sid *sid, int flags);
 334 void ndr_print_ipv4_addr(struct ndr_print *ndr, const char *name, const struct in_addr *_ip);
 335 void ndr_print_GUID(struct ndr_print *ndr, const char *name, const struct GUID *guid);
 336
 337 #endif /* __LIBNDR_H__ */