source4/lib/tdr/tdr.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    TDR (Trivial Data Representation) helper functions
   5      Based loosely on ndr.c by Andrew Tridgell.
   6
   7    Copyright (C) Jelmer Vernooij 2005
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #include "includes.h"
  24 #include "system/filesys.h"
  25 #include "system/network.h"
  26 #include "tdr/tdr.h"
  27
  28 #define TDR_BASE_MARSHALL_SIZE 1024
  29
  30 #define TDR_PUSH_NEED_BYTES(tdr, n) TDR_CHECK(tdr_push_expand(tdr, tdr->data.length+(n)))
  31
  32 #define TDR_PULL_NEED_BYTES(tdr, n) do { \
  33         if ((n) > tdr->data.length || tdr->offset + (n) > tdr->data.length) { \
  34                 return NT_STATUS_BUFFER_TOO_SMALL; \
  35         } \
  36 } while(0)
  37
  38 #define TDR_BE(tdr) ((tdr)->flags & TDR_BIG_ENDIAN)
  39
  40 #define TDR_CVAL(tdr, ofs) CVAL(tdr->data.data,ofs)
  41 #define TDR_SVAL(tdr, ofs) (TDR_BE(tdr)?RSVAL(tdr->data.data,ofs):SVAL(tdr->data.data,ofs))
  42 #define TDR_IVAL(tdr, ofs) (TDR_BE(tdr)?RIVAL(tdr->data.data,ofs):IVAL(tdr->data.data,ofs))
  43 #define TDR_SCVAL(tdr, ofs, v) SCVAL(tdr->data.data,ofs,v)
  44 #define TDR_SSVAL(tdr, ofs, v) do { if (TDR_BE(tdr))  { RSSVAL(tdr->data.data,ofs,v); } else SSVAL(tdr->data.data,ofs,v); } while (0)
  45 #define TDR_SIVAL(tdr, ofs, v) do { if (TDR_BE(tdr))  { RSIVAL(tdr->data.data,ofs,v); } else SIVAL(tdr->data.data,ofs,v); } while (0)
  46
  47 /**
  48   expand the available space in the buffer to 'size'
  49 */
  50 NTSTATUS tdr_push_expand(struct tdr_push *tdr, uint32_t size)
  51 {
  52         if (talloc_get_size(tdr->data.data) >= size) {
  53                 return NT_STATUS_OK;
  54         }
  55
  56         tdr->data.data = talloc_realloc(tdr, tdr->data.data, uint8_t, tdr->data.length + TDR_BASE_MARSHALL_SIZE);
  57
  58         if (tdr->data.data == NULL)
  59                 return NT_STATUS_NO_MEMORY;
  60
  61         return NT_STATUS_OK;
  62 }
  63
  64
  65 NTSTATUS tdr_pull_uint8(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint8_t *v)
  66 {
  67         TDR_PULL_NEED_BYTES(tdr, 1);
  68         *v = TDR_CVAL(tdr, tdr->offset);
  69         tdr->offset += 1;
  70         return NT_STATUS_OK;
  71 }
  72
  73 NTSTATUS tdr_push_uint8(struct tdr_push *tdr, const uint8_t *v)
  74 {
  75         TDR_PUSH_NEED_BYTES(tdr, 1);
  76         TDR_SCVAL(tdr, tdr->data.length, *v);
  77         tdr->data.length += 1;
  78         return NT_STATUS_OK;
  79 }
  80
  81 NTSTATUS tdr_print_uint8(struct tdr_print *tdr, const char *name, uint8_t *v)
  82 {
  83         tdr->print(tdr, "%-25s: 0x%02x (%u)", name, *v, *v);
  84         return NT_STATUS_OK;
  85 }
  86
  87 NTSTATUS tdr_pull_uint16(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint16_t *v)
  88 {
  89         TDR_PULL_NEED_BYTES(tdr, 2);
  90         *v = TDR_SVAL(tdr, tdr->offset);
  91         tdr->offset += 2;
  92         return NT_STATUS_OK;
  93 }
  94
  95 NTSTATUS tdr_push_uint16(struct tdr_push *tdr, const uint16_t *v)
  96 {
  97         TDR_PUSH_NEED_BYTES(tdr, 2);
  98         TDR_SSVAL(tdr, tdr->data.length, *v);
  99         tdr->data.length += 2;
 100         return NT_STATUS_OK;
 101 }
 102
 103 NTSTATUS tdr_print_uint16(struct tdr_print *tdr, const char *name, uint16_t *v)
 104 {
 105         tdr->print(tdr, "%-25s: 0x%02x (%u)", name, *v, *v);
 106         return NT_STATUS_OK;
 107 }
 108
 109 NTSTATUS tdr_pull_uint32(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint32_t *v)
 110 {
 111         TDR_PULL_NEED_BYTES(tdr, 4);
 112         *v = TDR_IVAL(tdr, tdr->offset);
 113         tdr->offset += 4;
 114         return NT_STATUS_OK;
 115 }
 116
 117 NTSTATUS tdr_push_uint32(struct tdr_push *tdr, const uint32_t *v)
 118 {
 119         TDR_PUSH_NEED_BYTES(tdr, 4);
 120         TDR_SIVAL(tdr, tdr->data.length, *v);
 121         tdr->data.length += 4;
 122         return NT_STATUS_OK;
 123 }
 124
 125 NTSTATUS tdr_print_uint32(struct tdr_print *tdr, const char *name, uint32_t *v)
 126 {
 127         tdr->print(tdr, "%-25s: 0x%02x (%u)", name, *v, *v);
 128         return NT_STATUS_OK;
 129 }
 130
 131 NTSTATUS tdr_pull_charset(struct tdr_pull *tdr, TALLOC_CTX *ctx, const char **v, uint32_t length, uint32_t el_size, charset_t chset)
 132 {
 133         int ret;
 134
 135         if (length == -1) {
 136                 switch (chset) {
 137                         case CH_DOS:
 138                                 length = ascii_len_n((const char*)tdr->data.data+tdr->offset, tdr->data.length-tdr->offset);
 139                                 break;
 140                         case CH_UTF16:
 141                                 length = utf16_len_n(tdr->data.data+tdr->offset, tdr->data.length-tdr->offset);
 142                                 break;
 143
 144                         default:
 145                                 return NT_STATUS_INVALID_PARAMETER;
 146                 }
 147         }
 148
 149         if (length == 0) {
 150                 *v = talloc_strdup(ctx, "");
 151                 return NT_STATUS_OK;
 152         }
 153
 154         TDR_PULL_NEED_BYTES(tdr, el_size*length);
 155
 156         ret = convert_string_talloc(ctx, chset, CH_UNIX, tdr->data.data+tdr->offset, el_size*length, discard_const_p(void *, v));
 157
 158         if (ret == -1) {
 159                 return NT_STATUS_INVALID_PARAMETER;
 160         }
 161
 162         tdr->offset += length * el_size;
 163
 164         return NT_STATUS_OK;
 165 }
 166
 167 NTSTATUS tdr_push_charset(struct tdr_push *tdr, const char **v, uint32_t length, uint32_t el_size, charset_t chset)
 168 {
 169         ssize_t ret, required;
 170
 171         if (length == -1) {
 172                 length = strlen(*v) + 1; /* Extra element for null character */
 173         }
 174
 175         required = el_size * length;
 176         TDR_PUSH_NEED_BYTES(tdr, required);
 177
 178         ret = convert_string(CH_UNIX, chset, *v, strlen(*v), tdr->data.data+tdr->data.length, required);
 179
 180         if (ret == -1) {
 181                 return NT_STATUS_INVALID_PARAMETER;
 182         }
 183
 184         /* Make sure the remaining part of the string is filled with zeroes */
 185         if (ret < required) {
 186                 memset(tdr->data.data+tdr->data.length+ret, 0, required-ret);
 187         }
 188
 189         tdr->data.length += required;
 190
 191         return NT_STATUS_OK;
 192 }
 193
 194 NTSTATUS tdr_print_charset(struct tdr_print *tdr, const char *name, const char **v, uint32_t length, uint32_t el_size, charset_t chset)
 195 {
 196         tdr->print(tdr, "%-25s: %s", name, *v);
 197         return NT_STATUS_OK;
 198 }
 199
 200 /**
 201   pull a ipv4address
 202 */
 203 NTSTATUS tdr_pull_ipv4address(struct tdr_pull *tdr, TALLOC_CTX *ctx,
 204                                                           const char **address)
 205 {
 206         struct ipv4_addr in;
 207         TDR_CHECK(tdr_pull_uint32(tdr, ctx, &in.addr));
 208         in.addr = htonl(in.addr);
 209         *address = talloc_strdup(tdr, sys_inet_ntoa(in));
 210         NT_STATUS_HAVE_NO_MEMORY(*address);
 211         return NT_STATUS_OK;
 212 }
 213
 214 /**
 215   push a ipv4address
 216 */
 217 NTSTATUS tdr_push_ipv4address(struct tdr_push *tdr, const char **address)
 218 {
 219         uint32_t addr = htonl(interpret_addr(*address));
 220         TDR_CHECK(tdr_push_uint32(tdr, &addr));
 221         return NT_STATUS_OK;
 222 }
 223
 224 /**
 225   print a ipv4address
 226 */
 227 NTSTATUS tdr_print_ipv4address(struct tdr_print *tdr, const char *name,
 228                            const char **address)
 229 {
 230         tdr->print(tdr, "%-25s: %s", name, *address);
 231         return NT_STATUS_OK;
 232 }
 233
 234 /**
 235   parse a hyper
 236 */
 237 NTSTATUS tdr_pull_hyper(struct tdr_pull *tdr, TALLOC_CTX *ctx, uint64_t *v)
 238 {
 239         TDR_PULL_NEED_BYTES(tdr, 8);
 240         *v = TDR_IVAL(tdr, tdr->offset);
 241         *v |= (uint64_t)(TDR_IVAL(tdr, tdr->offset+4)) << 32;
 242         tdr->offset += 8;
 243         return NT_STATUS_OK;
 244 }
 245
 246 /**
 247   push a hyper
 248 */
 249 NTSTATUS tdr_push_hyper(struct tdr_push *tdr, uint64_t *v)
 250 {
 251         TDR_PUSH_NEED_BYTES(tdr, 8);
 252         TDR_SIVAL(tdr, tdr->data.length, ((*v) & 0xFFFFFFFF));
 253         TDR_SIVAL(tdr, tdr->data.length+4, ((*v)>>32));
 254         tdr->data.length += 8;
 255         return NT_STATUS_OK;
 256 }
 257
 258 /**
 259   push a NTTIME
 260 */
 261 NTSTATUS tdr_push_NTTIME(struct tdr_push *tdr, NTTIME *t)
 262 {
 263         TDR_CHECK(tdr_push_hyper(tdr, t));
 264         return NT_STATUS_OK;
 265 }
 266
 267 /**
 268   pull a NTTIME
 269 */
 270 NTSTATUS tdr_pull_NTTIME(struct tdr_pull *tdr, TALLOC_CTX *ctx, NTTIME *t)
 271 {
 272         TDR_CHECK(tdr_pull_hyper(tdr, ctx, t));
 273         return NT_STATUS_OK;
 274 }
 275
 276 /**
 277   push a time_t
 278 */
 279 NTSTATUS tdr_push_time_t(struct tdr_push *tdr, time_t *t)
 280 {
 281         return tdr_push_uint32(tdr, (uint32_t *)t);
 282 }
 283
 284 /**
 285   pull a time_t
 286 */
 287 NTSTATUS tdr_pull_time_t(struct tdr_pull *tdr, TALLOC_CTX *ctx, time_t *t)
 288 {
 289         uint32_t tt;
 290         TDR_CHECK(tdr_pull_uint32(tdr, ctx, &tt));
 291         *t = tt;
 292         return NT_STATUS_OK;
 293 }
 294
 295 NTSTATUS tdr_print_time_t(struct tdr_print *tdr, const char *name, time_t *t)
 296 {
 297         if (*t == (time_t)-1 || *t == 0) {
 298                 tdr->print(tdr, "%-25s: (time_t)%d", name, (int)*t);
 299         } else {
 300                 tdr->print(tdr, "%-25s: %s", name, timestring(tdr, *t));
 301         }
 302
 303         return NT_STATUS_OK;
 304 }
 305
 306 NTSTATUS tdr_print_NTTIME(struct tdr_print *tdr, const char *name, NTTIME *t)
 307 {
 308         tdr->print(tdr, "%-25s: %s", name, nt_time_string(tdr, *t));
 309
 310         return NT_STATUS_OK;
 311 }
 312
 313 NTSTATUS tdr_print_DATA_BLOB(struct tdr_print *tdr, const char *name, DATA_BLOB *r)
 314 {
 315         tdr->print(tdr, "%-25s: DATA_BLOB length=%u", name, r->length);
 316         if (r->length) {
 317                 dump_data(10, r->data, r->length);
 318         }
 319
 320         return NT_STATUS_OK;
 321 }
 322
 323 #define TDR_ALIGN(l,n) (((l) & ((n)-1)) == 0?0:((n)-((l)&((n)-1))))
 324
 325 /*
 326   push a DATA_BLOB onto the wire.
 327 */
 328 NTSTATUS tdr_push_DATA_BLOB(struct tdr_push *tdr, DATA_BLOB *blob)
 329 {
 330         if (tdr->flags & TDR_ALIGN2) {
 331                 blob->length = TDR_ALIGN(tdr->data.length, 2);
 332         } else if (tdr->flags & TDR_ALIGN4) {
 333                 blob->length = TDR_ALIGN(tdr->data.length, 4);
 334         } else if (tdr->flags & TDR_ALIGN8) {
 335                 blob->length = TDR_ALIGN(tdr->data.length, 8);
 336         }
 337
 338         TDR_PUSH_NEED_BYTES(tdr, blob->length);
 339
 340         memcpy(tdr->data.data+tdr->data.length, blob->data, blob->length);
 341         return NT_STATUS_OK;
 342 }
 343
 344 /*
 345   pull a DATA_BLOB from the wire.
 346 */
 347 NTSTATUS tdr_pull_DATA_BLOB(struct tdr_pull *tdr, TALLOC_CTX *ctx, DATA_BLOB *blob)
 348 {
 349         uint32_t length;
 350
 351         if (tdr->flags & TDR_ALIGN2) {
 352                 length = TDR_ALIGN(tdr->offset, 2);
 353         } else if (tdr->flags & TDR_ALIGN4) {
 354                 length = TDR_ALIGN(tdr->offset, 4);
 355         } else if (tdr->flags & TDR_ALIGN8) {
 356                 length = TDR_ALIGN(tdr->offset, 8);
 357         } else if (tdr->flags & TDR_REMAINING) {
 358                 length = tdr->data.length - tdr->offset;
 359         } else {
 360                 return NT_STATUS_INVALID_PARAMETER;
 361         }
 362
 363         if (tdr->data.length - tdr->offset < length) {
 364                 length = tdr->data.length - tdr->offset;
 365         }
 366
 367         TDR_PULL_NEED_BYTES(tdr, length);
 368
 369         *blob = data_blob_talloc(tdr, tdr->data.data+tdr->offset, length);
 370         tdr->offset += length;
 371         return NT_STATUS_OK;
 372 }
 373
 374 NTSTATUS tdr_push_to_fd(int fd, tdr_push_fn_t push_fn, const void *p)
 375 {
 376         struct tdr_push *push = talloc_zero(NULL, struct tdr_push);
 377
 378         if (push == NULL)
 379                 return NT_STATUS_NO_MEMORY;
 380
 381         if (NT_STATUS_IS_ERR(push_fn(push, p))) {
 382                 DEBUG(1, ("Error pushing data\n"));
 383                 talloc_free(push);
 384                 return NT_STATUS_UNSUCCESSFUL;
 385         }
 386
 387         if (write(fd, push->data.data, push->data.length) < push->data.length) {
 388                 DEBUG(1, ("Error writing all data\n"));
 389                 return NT_STATUS_UNSUCCESSFUL;
 390         }
 391
 392         talloc_free(push);
 393
 394         return NT_STATUS_OK;
 395 }
 396
 397 void tdr_print_debug_helper(struct tdr_print *tdr, const char *format, ...) _PRINTF_ATTRIBUTE(2,3)
 398 {
 399         va_list ap;
 400         char *s = NULL;
 401         int i;
 402
 403         va_start(ap, format);
 404         vasprintf(&s, format, ap);
 405         va_end(ap);
 406
 407         for (i=0;i<tdr->level;i++) {
 408                 DEBUG(0,("    "));
 409         }
 410
 411         DEBUG(0,("%s\n", s));
 412         free(s);
 413 }