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         char *data;
  46         uint32_t data_size;
  47         uint32_t offset;
  48         TALLOC_CTX *mem_ctx;
  49
  50         struct ndr_token_list *relative_list;
  51
  52         /* this is used to ensure we generate unique reference IDs
  53            between request and reply */
  54         uint32_t ptr_count;
  55 };
  56
  57 struct ndr_pull_save {
  58         uint32_t data_size;
  59         uint32_t offset;
  60         struct ndr_pull_save *next;
  61 };
  62
  63 /* structure passed to functions that generate NDR formatted data */
  64 struct ndr_push {
  65         uint32_t flags; /* LIBNDR_FLAG_* */
  66         char *data;
  67         uint32_t alloc_size;
  68         uint32_t offset;
  69         TALLOC_CTX *mem_ctx;
  70
  71         struct ndr_token_list *relative_list;
  72
  73         /* this is used to ensure we generate unique reference IDs */
  74         uint32_t ptr_count;
  75 };
  76
  77 struct ndr_push_save {
  78         uint32_t offset;
  79         struct ndr_push_save *next;
  80 };
  81
  82
  83 /* structure passed to functions that print IDL structures */
  84 struct ndr_print {
  85         uint32_t flags; /* LIBNDR_FLAG_* */
  86         TALLOC_CTX *mem_ctx;
  87         uint32_t depth;
  88         void (*print)(struct ndr_print *, const char *, ...);
  89         void *private;
  90 };
  91
  92 #define LIBNDR_FLAG_BIGENDIAN  (1<<0)
  93 #define LIBNDR_FLAG_NOALIGN    (1<<1)
  94
  95 #define LIBNDR_FLAG_STR_ASCII    (1<<2)
  96 #define LIBNDR_FLAG_STR_LEN4     (1<<3)
  97 #define LIBNDR_FLAG_STR_SIZE4    (1<<4)
  98 #define LIBNDR_FLAG_STR_NOTERM   (1<<5)
  99 #define LIBNDR_FLAG_STR_NULLTERM (1<<6)
 100 #define LIBNDR_FLAG_STR_SIZE2    (1<<7)
 101 #define LIBNDR_FLAG_STR_BYTESIZE (1<<8)
 102 #define LIBNDR_STRING_FLAGS      (0x1FC)
 103
 104 #define LIBNDR_FLAG_REF_ALLOC    (1<<10)
 105 #define LIBNDR_FLAG_REMAINING    (1<<11)
 106 #define LIBNDR_FLAG_ALIGN2       (1<<12)
 107 #define LIBNDR_FLAG_ALIGN4       (1<<13)
 108 #define LIBNDR_FLAG_ALIGN8       (1<<14)
 109
 110 #define LIBNDR_ALIGN_FLAGS (LIBNDR_FLAG_ALIGN2|LIBNDR_FLAG_ALIGN4|LIBNDR_FLAG_ALIGN8)
 111
 112 #define LIBNDR_PRINT_ARRAY_HEX   (1<<15)
 113 #define LIBNDR_PRINT_SET_VALUES  (1<<16)
 114
 115 /* used to force a section of IDL to be little-endian */
 116 #define LIBNDR_FLAG_LITTLE_ENDIAN (1<<17)
 117
 118
 119 /* useful macro for debugging */
 120 #define NDR_PRINT_DEBUG(type, p) ndr_print_debug((ndr_print_fn_t)ndr_print_ ##type, #p, p)
 121 #define NDR_PRINT_UNION_DEBUG(type, level, p) ndr_print_union_debug((ndr_print_union_fn_t)ndr_print_ ##type, #p, level, p)
 122 #define NDR_PRINT_FUNCTION_DEBUG(type, flags, p) ndr_print_function_debug((ndr_print_function_t)ndr_print_ ##type, #type, flags, p)
 123 #define NDR_PRINT_BOTH_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_BOTH, p)
 124 #define NDR_PRINT_OUT_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_OUT, p)
 125 #define NDR_PRINT_IN_DEBUG(type, p) NDR_PRINT_FUNCTION_DEBUG(type, NDR_IN | NDR_SET_VALUES, p)
 126
 127
 128 enum ndr_err_code {
 129         NDR_ERR_CONFORMANT_SIZE,
 130         NDR_ERR_ARRAY_SIZE,
 131         NDR_ERR_BAD_SWITCH,
 132         NDR_ERR_OFFSET,
 133         NDR_ERR_RELATIVE,
 134         NDR_ERR_CHARCNV,
 135         NDR_ERR_LENGTH,
 136         NDR_ERR_SUBCONTEXT,
 137         NDR_ERR_STRING,
 138         NDR_ERR_VALIDATE,
 139         NDR_ERR_BUFSIZE,
 140         NDR_ERR_ALLOC
 141 };
 142
 143 /*
 144   flags passed to control parse flow
 145 */
 146 #define NDR_SCALARS 1
 147 #define NDR_BUFFERS 2
 148
 149 /*
 150   flags passed to ndr_print_*()
 151 */
 152 #define NDR_IN 1
 153 #define NDR_OUT 2
 154 #define NDR_BOTH 3
 155 #define NDR_SET_VALUES 4
 156
 157 #define NDR_PULL_NEED_BYTES(ndr, n) do { \
 158         if ((n) > ndr->data_size || ndr->offset + (n) > ndr->data_size) { \
 159                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull bytes %u", n); \
 160         } \
 161 } while(0)
 162
 163 #define NDR_ALIGN(ndr, n) ndr_align_size(ndr->offset, n)
 164
 165 #define NDR_PULL_ALIGN(ndr, n) do { \
 166         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 167                 ndr->offset = (ndr->offset + (n-1)) & ~(n-1); \
 168         } \
 169         if (ndr->offset >= ndr->data_size) { \
 170                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE, "Pull align %u", n); \
 171         } \
 172 } while(0)
 173
 174 #define NDR_PUSH_NEED_BYTES(ndr, n) NDR_CHECK(ndr_push_expand(ndr, ndr->offset+(n)))
 175
 176 #define NDR_PUSH_ALIGN(ndr, n) do { \
 177         if (!(ndr->flags & LIBNDR_FLAG_NOALIGN)) { \
 178                 uint32_t _pad = ((ndr->offset + (n-1)) & ~(n-1)) - ndr->offset; \
 179                 while (_pad--) NDR_CHECK(ndr_push_uint8(ndr, 0)); \
 180         } \
 181 } while(0)
 182
 183
 184 /* these are used to make the error checking on each element in libndr
 185    less tedious, hopefully making the code more readable */
 186 #define NDR_CHECK(call) do { NTSTATUS _status; \
 187                              _status = call; \
 188                              if (!NT_STATUS_IS_OK(_status)) \
 189                                 return _status; \
 190                         } while (0)
 191
 192
 193 #define NDR_ALLOC_SIZE(ndr, s, size) do { \
 194                                (s) = talloc(ndr->mem_ctx, size); \
 195                                if ((size) && !(s)) return ndr_pull_error(ndr, NDR_ERR_ALLOC, \
 196                                                                "Alloc %u failed\n", \
 197                                                                size); \
 198                            } while (0)
 199
 200 #define NDR_ALLOC(ndr, s) NDR_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 201
 202
 203 #define NDR_ALLOC_N_SIZE(ndr, s, n, elsize) do { \
 204                                 if ((n) == 0) { \
 205                                         (s) = NULL; \
 206                                 } else { \
 207                                         (s) = talloc(ndr->mem_ctx, (n) * elsize); \
 208                                         if (!(s)) return ndr_pull_error(ndr, \
 209                                                                         NDR_ERR_ALLOC, \
 210                                                                         "Alloc %u * %u failed\n", \
 211                                                                         n, elsize); \
 212                                 } \
 213                            } while (0)
 214
 215 #define NDR_ALLOC_N(ndr, s, n) NDR_ALLOC_N_SIZE(ndr, s, n, sizeof(*(s)))
 216
 217
 218 #define NDR_PUSH_ALLOC_SIZE(ndr, s, size) do { \
 219                                (s) = talloc(ndr->mem_ctx, size); \
 220                                if ((size) && !(s)) return ndr_push_error(ndr, NDR_ERR_ALLOC, \
 221                                                                "push alloc %u failed\n",\
 222                                                                size); \
 223                            } while (0)
 224
 225 #define NDR_PUSH_ALLOC(ndr, s) NDR_PUSH_ALLOC_SIZE(ndr, s, sizeof(*(s)))
 226
 227
 228 /* these are used when generic fn pointers are needed for ndr push/pull fns */
 229 typedef NTSTATUS (*ndr_push_fn_t)(struct ndr_push *, void *);
 230 typedef NTSTATUS (*ndr_pull_fn_t)(struct ndr_pull *, void *);
 231
 232 typedef NTSTATUS (*ndr_push_flags_fn_t)(struct ndr_push *, int ndr_flags, void *);
 233 typedef NTSTATUS (*ndr_push_const_fn_t)(struct ndr_push *, int ndr_flags, const void *);
 234 typedef NTSTATUS (*ndr_pull_flags_fn_t)(struct ndr_pull *, int ndr_flags, void *);
 235 typedef NTSTATUS (*ndr_push_union_fn_t)(struct ndr_push *, int ndr_flags, uint32_t, void *);
 236 typedef NTSTATUS (*ndr_pull_union_fn_t)(struct ndr_pull *, int ndr_flags, uint32_t, void *);
 237 typedef void (*ndr_print_fn_t)(struct ndr_print *, const char *, void *);
 238 typedef void (*ndr_print_function_t)(struct ndr_print *, const char *, int, void *);
 239 typedef void (*ndr_print_union_fn_t)(struct ndr_print *, const char *, uint32_t, void *);
 240
 241 #include "librpc/ndr/ndr_sec.h"
 242
 243 /* now pull in the individual parsers */
 244 #include "librpc/gen_ndr/tables.h"