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 2 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, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 /*
  22   this provides definitions for the libcli/rpc/ MSRPC library
  23 */
  24
  25
  26 /*
  27   this is used by the token store/retrieve code
  28 */
  29 struct ndr_token_list {
  30         struct ndr_token_list *next, *prev;
  31         const void *key;
  32         uint32_t value;
  33 };
  34
  35 /* this is the base structure passed to routines that
  36    parse MSRPC formatted data
  37
  38    note that in Samba4 we use separate routines and structures for
  39    MSRPC marshalling and unmarshalling. Also note that these routines
  40    are being kept deliberately very simple, and are not tied to a
  41    particular transport
  42 */
  43 struct ndr_pull {
  44         uint32_t flags; /* LIBNDR_FLAG_* */
  45         uint8_t *data;
  46         uint32_t data_size;
  47         uint32_t offset;
  48
  49         uint32_t relative_base_offset;
  50         struct ndr_token_list *relative_base_list;
  51
  52         struct ndr_token_list *relative_list;
  53         struct ndr_token_list *array_size_list;
  54         struct ndr_token_list *array_length_list;
  55         struct ndr_token_list *switch_list;
  56
  57         /* this is used to ensure we generate unique reference IDs
  58            between request and reply */
  59         uint32_t ptr_count;
  60 };
  61
  62 struct ndr_pull_save {
  63         uint32_t data_size;
  64         uint32_t offset;
  65         struct ndr_pull_save *next;
  66 };
  67
  68 /* structure passed to functions that generate NDR formatted data */
  69 struct ndr_push {
  70         uint32_t flags; /* LIBNDR_FLAG_* */
  71         uint8_t *data;
  72         uint32_t alloc_size;
  73         uint32_t offset;
  74
  75         uint32_t relative_base_offset;
  76         struct ndr_token_list *relative_base_list;
  77
  78         struct ndr_token_list *switch_list;
  79         struct ndr_token_list *relative_list;
  80
  81         /* this is used to ensure we generate unique reference IDs */
  82         uint32_t ptr_count;
  83 };
  84
  85 struct ndr_push_save {
  86         uint32_t offset;
  87         struct ndr_push_save *next;
  88 };
  89
  90
  91 /* structure passed to functions that print IDL structures */
  92 struct ndr_print {
  93         uint32_t flags; /* LIBNDR_FLAG_* */
  94         uint32_t depth;
  95         struct ndr_token_list *switch_list;
  96         void (*print)(struct ndr_print *, const char *, ...);
  97         void *private;
  98 };
  99
 100 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
 101 #define LIBNDR_FLAG_NOALIGN    (1<<1)
 102
 103 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
 104 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
 105 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
 106 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
 107 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
 108 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
 109 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
 110 #define LIBNDR_FLAG_STR_FIXLEN32        (1<<9)
 111 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
 112 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
 113 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
 114 #define LIBNDR_FLAG_STR_FIXLEN15        (1<<13)
 115 #define LIBNDR_STRING_FLAGS             (0x3FFC)
 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_ARRAY_SIZE,
 153         NDR_ERR_BAD_SWITCH,
 154         NDR_ERR_OFFSET,
 155         NDR_ERR_RELATIVE,
 156         NDR_ERR_CHARCNV,
 157         NDR_ERR_LENGTH,
 158         NDR_ERR_SUBCONTEXT,
 159         NDR_ERR_COMPRESSION,
 160         NDR_ERR_STRING,
 161         NDR_ERR_VALIDATE,
 162         NDR_ERR_BUFSIZE,
 163         NDR_ERR_ALLOC,
 164         NDR_ERR_RANGE,
 165         NDR_ERR_TOKEN
 166 };
 167
 168 enum ndr_compression_alg {
 169         NDR_COMPRESSION_MSZIP
 170 };
 171
 172 /*
 173   flags passed to control parse flow
 174 */
 175 #define NDR_SCALARS 1
 176 #define NDR_BUFFERS 2
 177
 178 /*
 179   flags passed to ndr_print_*()
 180 */
 181 #define NDR_IN 1
 182 #define NDR_OUT 2
 183 #define NDR_BOTH 3
 184 #define NDR_SET_VALUES 4
 185
 186 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 187         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
 188                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
 189         } \
 190 } while(0)
 191
 192 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 193
 194 #define NDR_PULL_ALIGN(ndr, n) do { \
 195         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 196                 if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
 197                         ndr_check_padding(ndr, n); \
 198                 } \
 199                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 200         } \
 201         if (ndr->offset > ndr->data_size) { \
 202                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
 203         } \
 204 } while(0)
 205
 206 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
 207
 208 #define NDR_PUSH_ALIGN(ndr, n) do { \
 209         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 210                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 211                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 0)); \
 212         } \
 213 } while(0)
 214
 215 /* these are used to make the error checking on each element in libndr
 216    less tedious, hopefully making the code more readable */
 217 #define NDR_CHECK(call) do { NTSTATUS _status; \
 218                              _status = call; \
 219                              if (!NT_STATUS_IS_OK(_status)) \
 220                                 return _status; \
 221                         } while (0)
 222
 223
 224 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
 225                                (s) = talloc_size(ndr, size); \
 226                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
 227                                                                "Alloc %u failed\n", \
 228                                                                size); \
 229                            } while (0)
 230
 231 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 232
 233
 234 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
 235         (s) = talloc_array_size(ndr, elsize, n); \
 236         if (!(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, "Alloc %u * %u failed\n", n, elsize); \
 237 } while (0)
 238
 239 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
 240
 241
 242 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 243        (s) = talloc_size(ndr, size); \
 244        if (!(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, "push alloc %u failed\n", size); \
 245 } while (0)
 246
 247 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 248
 249 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 250 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
 251 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 252 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 253 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
 254 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
 255