source4/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         struct ndr_token_list *relative_list;
  50
  51         /* this is used to ensure we generate unique reference IDs
  52            between request and reply */
  53         uint32_t ptr_count;
  54 };
  55
  56 struct ndr_pull_save {
  57         uint32_t data_size;
  58         uint32_t offset;
  59         struct ndr_pull_save *next;
  60 };
  61
  62 /* structure passed to functions that generate NDR formatted data */
  63 struct ndr_push {
  64         uint32_t flags; /* LIBNDR_FLAG_* */
  65         uint8_t *data;
  66         uint32_t alloc_size;
  67         uint32_t offset;
  68
  69         struct ndr_token_list *relative_list;
  70
  71         /* this is used to ensure we generate unique reference IDs */
  72         uint32_t ptr_count;
  73 };
  74
  75 struct ndr_push_save {
  76         uint32_t offset;
  77         struct ndr_push_save *next;
  78 };
  79
  80
  81 /* structure passed to functions that print IDL structures */
  82 struct ndr_print {
  83         uint32_t flags; /* LIBNDR_FLAG_* */
  84         uint32_t depth;
  85         void (*print)(struct ndr_print *, const char *, ...);
  86         void *private;
  87 };
  88
  89 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
  90 #define LIBNDR_FLAG_NOALIGN    (1<<1)
  91
  92 #define LIBNDR_FLAG_STR_ASCII           (1<<2)
  93 #define LIBNDR_FLAG_STR_LEN4            (1<<3)
  94 #define LIBNDR_FLAG_STR_SIZE4           (1<<4)
  95 #define LIBNDR_FLAG_STR_NOTERM          (1<<5)
  96 #define LIBNDR_FLAG_STR_NULLTERM        (1<<6)
  97 #define LIBNDR_FLAG_STR_SIZE2           (1<<7)
  98 #define LIBNDR_FLAG_STR_BYTESIZE        (1<<8)
  99 #define LIBNDR_FLAG_STR_FIXLEN32        (1<<9)
 100 #define LIBNDR_FLAG_STR_CONFORMANT      (1<<10)
 101 #define LIBNDR_FLAG_STR_CHARLEN         (1<<11)
 102 #define LIBNDR_FLAG_STR_UTF8            (1<<12)
 103 #define LIBNDR_STRING_FLAGS             (0x1FFC)
 104
 105
 106 #define LIBNDR_FLAG_REF_ALLOC    (1<<20)
 107 #define LIBNDR_FLAG_REMAINING    (1<<21)
 108 #define LIBNDR_FLAG_ALIGN2       (1<<22)
 109 #define LIBNDR_FLAG_ALIGN4       (1<<23)
 110 #define LIBNDR_FLAG_ALIGN8       (1<<24)
 111
 112 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
 113
 114 #define LIBNDR_PRINT_ARRAY_HEX   (1<<25)
 115 #define LIBNDR_PRINT_SET_VALUES  (1<<26)
 116
 117 /* used to force a section of IDL to be little-endian */
 118 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<27)
 119
 120 /* used to check if alignment padding is zero */
 121 #define LIBNDR_FLAG_PAD_CHECK     (1<<28)
 122
 123 /* used to indicate spoolss style relative pointers (relative to current
 124    offset, not base) */
 125 #define LIBNDR_FLAG_RELATIVE_CURRENT  (1<<29)
 126
 127 /* set if an object uuid will be present */
 128 #define LIBNDR_FLAG_OBJECT_PRESENT    (1<<30)
 129
 130 /* useful macro for debugging */
 131 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 132 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
 133 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 134 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
 135 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
 136 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 137
 138
 139 enum ndr_err_code {
 140         NDR_ERR_CONFORMANT_SIZE,
 141         NDR_ERR_ARRAY_SIZE,
 142         NDR_ERR_BAD_SWITCH,
 143         NDR_ERR_OFFSET,
 144         NDR_ERR_RELATIVE,
 145         NDR_ERR_CHARCNV,
 146         NDR_ERR_LENGTH,
 147         NDR_ERR_SUBCONTEXT,
 148         NDR_ERR_STRING,
 149         NDR_ERR_VALIDATE,
 150         NDR_ERR_BUFSIZE,
 151         NDR_ERR_ALLOC,
 152         NDR_ERR_RANGE
 153 };
 154
 155 /*
 156   flags passed to control parse flow
 157 */
 158 #define NDR_SCALARS 1
 159 #define NDR_BUFFERS 2
 160
 161 /*
 162   flags passed to ndr_print_*()
 163 */
 164 #define NDR_IN 1
 165 #define NDR_OUT 2
 166 #define NDR_BOTH 3
 167 #define NDR_SET_VALUES 4
 168
 169 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 170         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
 171                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
 172         } \
 173 } while(0)
 174
 175 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 176
 177 #define NDR_PULL_ALIGN(ndr, n) do { \
 178         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 179                 if (ndr->flags & LIBNDR_FLAG_PAD_CHECK) { \
 180                         ndr_check_padding(ndr, n); \
 181                 } \
 182                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 183         } \
 184         if (ndr->offset >= ndr->data_size) { \
 185                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
 186         } \
 187 } while(0)
 188
 189 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
 190
 191 #define NDR_PUSH_ALIGN(ndr, n) do { \
 192         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 193                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 194                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
 195         } \
 196 } while(0)
 197
 198 #define NDR_SIZE_ALIGN(t, n, flags) ((flags & LIBNDR_FLAG_NOALIGN)?(t):(((t) + (n-1)) & ~(n-1)))
 199 #define ndr_size_uint8(t, p, flags) (NDR_SIZE_ALIGN(t, 1, flags) + 1)
 200 #define ndr_size_uint16(t, p, flags) (NDR_SIZE_ALIGN(t, 2, flags) + 2)
 201 #define ndr_size_int32(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 4)
 202 #define ndr_size_uint32(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 4)
 203 #define ndr_size_ptr(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 4)
 204 /*
 205  * [u]int64 uses 4 Byte alignment
 206  * and HYPER_T uses 8 Byte alignment
 207  */
 208 #define ndr_size_int64(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 8)
 209 #define ndr_size_uint64(t, p, flags) (NDR_SIZE_ALIGN(t, 4, flags) + 8)
 210 #define ndr_size_HYPER_T(t, p, flags) (NDR_SIZE_ALIGN(t, 8, flags) + 8)
 211
 212
 213 #define ndr_size_NTTIME(t, p, flags) ndr_size_uint64(t, p, flags)
 214 #define ndr_size_NTTIME_1sec(t, p, flags) ndr_size_HYPER_T(t, p, flags)
 215
 216 #define ndr_size_WERROR(t, p, flags) ndr_size_uint32(t, p, flags)
 217 #define ndr_size_NTSTATUS(t, p, flags) ndr_size_uint32(t, p, flags)
 218
 219 /* these are used to make the error checking on each element in libndr
 220    less tedious, hopefully making the code more readable */
 221 #define NDR_CHECK(call) do { NTSTATUS _status; \
 222                              _status = call; \
 223                              if (!NT_STATUS_IS_OK(_status)) \
 224                                 return _status; \
 225                         } while (0)
 226
 227
 228 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
 229                                (s) = talloc(ndr, size); \
 230                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
 231                                                                "Alloc %u failed\n", \
 232                                                                size); \
 233                            } while (0)
 234
 235 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 236
 237
 238 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
 239                                 if ((n) == 0) { \
 240                                         (s) = NULL; \
 241                                 } else { \
 242                                         (s) = talloc_array(ndr, elsize, n, __location__); \
 243                                         if (!(s)) return ndr_pull_error(ndr, \
 244                                                                         NDR_ERR_ALLOC, \
 245                                                                         "Alloc %u * %u failed\n", \
 246                                                                         n, elsize); \
 247                                 } \
 248                            } while (0)
 249
 250 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
 251
 252
 253 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 254                                (s) = talloc(ndr, size); \
 255                                if ((size) && !(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, \
 256                                                                "push alloc %u failed\n",\
 257                                                                size); \
 258                            } while (0)
 259
 260 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 261
 262
 263 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 264 typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
 265 typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
 266
 267 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
 268 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 269 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 270 typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint32_t, void *);
 271 typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint32_t, void *);
 272 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
 273 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
 274 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint32_t, void *);
 275