librpc/ndr/ndr.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    libndr interface
   5
   6    Copyright (C) Andrew Tridgell 2003
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 /*
  23   this provides the core routines for NDR parsing functions
  24
  25   see http://www.opengroup.org/onlinepubs/9629399/chap14.htm for details
  26   of NDR encoding rules
  27 */
  28
  29 #include "includes.h"
  30 #include "librpc/ndr/libndr.h"
  31 #include "../lib/util/dlinklist.h"
  32 #if _SAMBA_BUILD_ == 4
  33 #include "param/param.h"
  34 #endif
  35
  36 #define NDR_BASE_MARSHALL_SIZE 1024
  37
  38 /* this guid indicates NDR encoding in a protocol tower */
  39 const struct ndr_syntax_id ndr_transfer_syntax = {
  40   { 0x8a885d04, 0x1ceb, 0x11c9, {0x9f, 0xe8}, {0x08,0x00,0x2b,0x10,0x48,0x60} },
  41   2
  42 };
  43
  44 const struct ndr_syntax_id ndr64_transfer_syntax = {
  45   { 0x71710533, 0xbeba, 0x4937, {0x83, 0x19}, {0xb5,0xdb,0xef,0x9c,0xcc,0x36} },
  46   1
  47 };
  48
  49 /*
  50   work out the number of bytes needed to align on a n byte boundary
  51 */
  52 _PUBLIC_ size_t ndr_align_size(uint32_t offset, size_t n)
  53 {
  54         if ((offset & (n-1)) == 0) return 0;
  55         return n - (offset & (n-1));
  56 }
  57
  58 /*
  59   initialise a ndr parse structure from a data blob
  60 */
  61 _PUBLIC_ struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience)
  62 {
  63         struct ndr_pull *ndr;
  64
  65         ndr = talloc_zero(mem_ctx, struct ndr_pull);
  66         if (!ndr) return NULL;
  67         ndr->current_mem_ctx = mem_ctx;
  68
  69         ndr->data = blob->data;
  70         ndr->data_size = blob->length;
  71         ndr->iconv_convenience = talloc_reference(ndr, iconv_convenience);
  72
  73         return ndr;
  74 }
  75
  76 /*
  77   advance by 'size' bytes
  78 */
  79 _PUBLIC_ enum ndr_err_code ndr_pull_advance(struct ndr_pull *ndr, uint32_t size)
  80 {
  81         ndr->offset += size;
  82         if (ndr->offset > ndr->data_size) {
  83                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
  84                                       "ndr_pull_advance by %u failed",
  85                                       size);
  86         }
  87         return NDR_ERR_SUCCESS;
  88 }
  89
  90 /*
  91   set the parse offset to 'ofs'
  92 */
  93 static enum ndr_err_code ndr_pull_set_offset(struct ndr_pull *ndr, uint32_t ofs)
  94 {
  95         ndr->offset = ofs;
  96         if (ndr->offset > ndr->data_size) {
  97                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
  98                                       "ndr_pull_set_offset %u failed",
  99                                       ofs);
 100         }
 101         return NDR_ERR_SUCCESS;
 102 }
 103
 104 /* create a ndr_push structure, ready for some marshalling */
 105 _PUBLIC_ struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience)
 106 {
 107         struct ndr_push *ndr;
 108
 109         ndr = talloc_zero(mem_ctx, struct ndr_push);
 110         if (!ndr) {
 111                 return NULL;
 112         }
 113
 114         ndr->flags = 0;
 115         ndr->alloc_size = NDR_BASE_MARSHALL_SIZE;
 116         ndr->data = talloc_array(ndr, uint8_t, ndr->alloc_size);
 117         if (!ndr->data) {
 118                 return NULL;
 119         }
 120         ndr->iconv_convenience = talloc_reference(ndr, iconv_convenience);
 121
 122         return ndr;
 123 }
 124
 125 /* return a DATA_BLOB structure for the current ndr_push marshalled data */
 126 _PUBLIC_ DATA_BLOB ndr_push_blob(struct ndr_push *ndr)
 127 {
 128         DATA_BLOB blob;
 129         blob = data_blob_const(ndr->data, ndr->offset);
 130         if (ndr->alloc_size > ndr->offset) {
 131                 ndr->data[ndr->offset] = 0;
 132         }
 133         return blob;
 134 }
 135
 136
 137 /*
 138   expand the available space in the buffer to ndr->offset + extra_size
 139 */
 140 _PUBLIC_ enum ndr_err_code ndr_push_expand(struct ndr_push *ndr, uint32_t extra_size)
 141 {
 142         uint32_t size = extra_size + ndr->offset;
 143
 144         if (size < ndr->offset) {
 145                 /* extra_size overflowed the offset */
 146                 return ndr_push_error(ndr, NDR_ERR_BUFSIZE, "Overflow in push_expand to %u",
 147                                       size);
 148         }
 149
 150         if (ndr->alloc_size > size) {
 151                 return NDR_ERR_SUCCESS;
 152         }
 153
 154         ndr->alloc_size += NDR_BASE_MARSHALL_SIZE;
 155         if (size+1 > ndr->alloc_size) {
 156                 ndr->alloc_size = size+1;
 157         }
 158         ndr->data = talloc_realloc(ndr, ndr->data, uint8_t, ndr->alloc_size);
 159         if (!ndr->data) {
 160                 return ndr_push_error(ndr, NDR_ERR_ALLOC, "Failed to push_expand to %u",
 161                                       ndr->alloc_size);
 162         }
 163
 164         return NDR_ERR_SUCCESS;
 165 }
 166
 167 _PUBLIC_ void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...)
 168 {
 169         va_list ap;
 170         char *s = NULL;
 171         int i, ret;
 172
 173         va_start(ap, format);
 174         ret = vasprintf(&s, format, ap);
 175         va_end(ap);
 176
 177         if (ret == -1) {
 178                 return;
 179         }
 180
 181         for (i=0;i<ndr->depth;i++) {
 182                 DEBUGADD(1,("    "));
 183         }
 184
 185         DEBUGADD(1,("%s\n", s));
 186         free(s);
 187 }
 188
 189 _PUBLIC_ void ndr_print_string_helper(struct ndr_print *ndr, const char *format, ...)
 190 {
 191         va_list ap;
 192         int i;
 193
 194         for (i=0;i<ndr->depth;i++) {
 195                 ndr->private_data = talloc_asprintf_append_buffer(
 196                                         (char *)ndr->private_data, "    ");
 197         }
 198
 199         va_start(ap, format);
 200         ndr->private_data = talloc_vasprintf_append_buffer((char *)ndr->private_data,
 201                                                     format, ap);
 202         va_end(ap);
 203         ndr->private_data = talloc_asprintf_append_buffer((char *)ndr->private_data,
 204                                                    "\n");
 205 }
 206
 207 /*
 208   a useful helper function for printing idl structures via DEBUG()
 209 */
 210 _PUBLIC_ void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr)
 211 {
 212         struct ndr_print *ndr;
 213
 214         DEBUG(1,(" "));
 215
 216         ndr = talloc_zero(NULL, struct ndr_print);
 217         if (!ndr) return;
 218         ndr->print = ndr_print_debug_helper;
 219         ndr->depth = 1;
 220         ndr->flags = 0;
 221         fn(ndr, name, ptr);
 222         talloc_free(ndr);
 223 }
 224
 225 /*
 226   a useful helper function for printing idl unions via DEBUG()
 227 */
 228 _PUBLIC_ void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
 229 {
 230         struct ndr_print *ndr;
 231
 232         DEBUG(1,(" "));
 233
 234         ndr = talloc_zero(NULL, struct ndr_print);
 235         if (!ndr) return;
 236         ndr->print = ndr_print_debug_helper;
 237         ndr->depth = 1;
 238         ndr->flags = 0;
 239         ndr_print_set_switch_value(ndr, ptr, level);
 240         fn(ndr, name, ptr);
 241         talloc_free(ndr);
 242 }
 243
 244 /*
 245   a useful helper function for printing idl function calls via DEBUG()
 246 */
 247 _PUBLIC_ void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr)
 248 {
 249         struct ndr_print *ndr;
 250
 251         DEBUG(1,(" "));
 252
 253         ndr = talloc_zero(NULL, struct ndr_print);
 254         if (!ndr) return;
 255         ndr->print = ndr_print_debug_helper;
 256         ndr->depth = 1;
 257         ndr->flags = 0;
 258         fn(ndr, name, flags, ptr);
 259         talloc_free(ndr);
 260 }
 261
 262 /*
 263   a useful helper function for printing idl structures to a string
 264 */
 265 _PUBLIC_ char *ndr_print_struct_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, void *ptr)
 266 {
 267         struct ndr_print *ndr;
 268         char *ret = NULL;
 269
 270         ndr = talloc_zero(mem_ctx, struct ndr_print);
 271         if (!ndr) return NULL;
 272         ndr->private_data = talloc_strdup(ndr, "");
 273         if (!ndr->private_data) {
 274                 goto failed;
 275         }
 276         ndr->print = ndr_print_string_helper;
 277         ndr->depth = 1;
 278         ndr->flags = 0;
 279         fn(ndr, name, ptr);
 280         ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
 281 failed:
 282         talloc_free(ndr);
 283         return ret;
 284 }
 285
 286 /*
 287   a useful helper function for printing idl unions to a string
 288 */
 289 _PUBLIC_ char *ndr_print_union_string(TALLOC_CTX *mem_ctx, ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
 290 {
 291         struct ndr_print *ndr;
 292         char *ret = NULL;
 293
 294         ndr = talloc_zero(mem_ctx, struct ndr_print);
 295         if (!ndr) return NULL;
 296         ndr->private_data = talloc_strdup(ndr, "");
 297         if (!ndr->private_data) {
 298                 goto failed;
 299         }
 300         ndr->print = ndr_print_string_helper;
 301         ndr->depth = 1;
 302         ndr->flags = 0;
 303         ndr_print_set_switch_value(ndr, ptr, level);
 304         fn(ndr, name, ptr);
 305         ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
 306 failed:
 307         talloc_free(ndr);
 308         return ret;
 309 }
 310
 311 /*
 312   a useful helper function for printing idl function calls to a string
 313 */
 314 _PUBLIC_ char *ndr_print_function_string(TALLOC_CTX *mem_ctx,
 315                                 ndr_print_function_t fn, const char *name,
 316                                 int flags, void *ptr)
 317 {
 318         struct ndr_print *ndr;
 319         char *ret = NULL;
 320
 321         ndr = talloc_zero(mem_ctx, struct ndr_print);
 322         if (!ndr) return NULL;
 323         ndr->private_data = talloc_strdup(ndr, "");
 324         if (!ndr->private_data) {
 325                 goto failed;
 326         }
 327         ndr->print = ndr_print_string_helper;
 328         ndr->depth = 1;
 329         ndr->flags = 0;
 330         fn(ndr, name, flags, ptr);
 331         ret = talloc_steal(mem_ctx, (char *)ndr->private_data);
 332 failed:
 333         talloc_free(ndr);
 334         return ret;
 335 }
 336
 337 _PUBLIC_ void ndr_set_flags(uint32_t *pflags, uint32_t new_flags)
 338 {
 339         /* the big/little endian flags are inter-dependent */
 340         if (new_flags & LIBNDR_FLAG_LITTLE_ENDIAN) {
 341                 (*pflags) &= ~LIBNDR_FLAG_BIGENDIAN;
 342         }
 343         if (new_flags & LIBNDR_FLAG_BIGENDIAN) {
 344                 (*pflags) &= ~LIBNDR_FLAG_LITTLE_ENDIAN;
 345         }
 346         if (new_flags & LIBNDR_FLAG_REMAINING) {
 347                 (*pflags) &= ~LIBNDR_ALIGN_FLAGS;
 348         }
 349         if (new_flags & LIBNDR_ALIGN_FLAGS) {
 350                 (*pflags) &= ~LIBNDR_FLAG_REMAINING;
 351         }
 352         if (new_flags & LIBNDR_FLAG_NO_RELATIVE_REVERSE) {
 353                 (*pflags) &= ~LIBNDR_FLAG_RELATIVE_REVERSE;
 354         }
 355         (*pflags) |= new_flags;
 356 }
 357
 358 /*
 359   return and possibly log an NDR error
 360 */
 361 _PUBLIC_ enum ndr_err_code ndr_pull_error(struct ndr_pull *ndr,
 362                                  enum ndr_err_code ndr_err,
 363                                  const char *format, ...)
 364 {
 365         char *s=NULL;
 366         va_list ap;
 367         int ret;
 368
 369         va_start(ap, format);
 370         ret = vasprintf(&s, format, ap);
 371         va_end(ap);
 372
 373         if (ret == -1) {
 374                 return NDR_ERR_ALLOC;
 375         }
 376
 377         DEBUG(1,("ndr_pull_error(%u): %s\n", ndr_err, s));
 378
 379         free(s);
 380
 381         return ndr_err;
 382 }
 383
 384 /*
 385   return and possibly log an NDR error
 386 */
 387 _PUBLIC_ enum ndr_err_code ndr_push_error(struct ndr_push *ndr,
 388                                  enum ndr_err_code ndr_err,
 389                                  const char *format, ...)
 390 {
 391         char *s=NULL;
 392         va_list ap;
 393         int ret;
 394
 395         va_start(ap, format);
 396         ret = vasprintf(&s, format, ap);
 397         va_end(ap);
 398
 399         if (ret == -1) {
 400                 return NDR_ERR_ALLOC;
 401         }
 402
 403         DEBUG(1,("ndr_push_error(%u): %s\n", ndr_err, s));
 404
 405         free(s);
 406
 407         return ndr_err;
 408 }
 409
 410 /*
 411   handle subcontext buffers, which in midl land are user-marshalled, but
 412   we use magic in pidl to make them easier to cope with
 413 */
 414 _PUBLIC_ enum ndr_err_code ndr_pull_subcontext_start(struct ndr_pull *ndr,
 415                                    struct ndr_pull **_subndr,
 416                                    size_t header_size,
 417                                    ssize_t size_is)
 418 {
 419         struct ndr_pull *subndr;
 420         uint32_t r_content_size;
 421         bool force_le = false;
 422         bool force_be = false;
 423
 424         switch (header_size) {
 425         case 0: {
 426                 uint32_t content_size = ndr->data_size - ndr->offset;
 427                 if (size_is >= 0) {
 428                         content_size = size_is;
 429                 }
 430                 r_content_size = content_size;
 431                 break;
 432         }
 433
 434         case 2: {
 435                 uint16_t content_size;
 436                 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &content_size));
 437                 if (size_is >= 0 && size_is != content_size) {
 438                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 439                                                 (int)size_is, (int)content_size);
 440                 }
 441                 r_content_size = content_size;
 442                 break;
 443         }
 444
 445         case 4: {
 446                 uint32_t content_size;
 447                 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
 448                 if (size_is >= 0 && size_is != content_size) {
 449                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 450                                                 (int)size_is, (int)content_size);
 451                 }
 452                 r_content_size = content_size;
 453                 break;
 454         }
 455         case 0xFFFFFC01: {
 456                 /*
 457                  * Common Type Header for the Serialization Stream
 458                  * See [MS-RPCE] 2.2.6 Type Serialization Version 1
 459                  */
 460                 uint8_t version;
 461                 uint8_t drep;
 462                 uint16_t hdrlen;
 463                 uint32_t filler;
 464                 uint32_t content_size;
 465                 uint32_t reserved;
 466
 467                 /* version */
 468                 NDR_CHECK(ndr_pull_uint8(ndr, NDR_SCALARS, &version));
 469
 470                 if (version != 1) {
 471                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
 472                                               "Bad subcontext (PULL) Common Type Header version %d != 1",
 473                                               (int)version);
 474                 }
 475
 476                 /*
 477                  * 0x10 little endian
 478                  * 0x00 big endian
 479                  */
 480                 NDR_CHECK(ndr_pull_uint8(ndr, NDR_SCALARS, &drep));
 481                 if (drep == 0x10) {
 482                         force_le = true;
 483                 } else if (drep == 0x00) {
 484                         force_be = true;
 485                 } else {
 486                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
 487                                               "Bad subcontext (PULL) Common Type Header invalid drep 0x%02X",
 488                                               (unsigned int)drep);
 489                 }
 490
 491                 /* length of the "Private Header for Constructed Type" */
 492                 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &hdrlen));
 493                 if (hdrlen != 8) {
 494                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
 495                                               "Bad subcontext (PULL) Common Type Header length %d != 8",
 496                                               (int)hdrlen);
 497                 }
 498
 499                 /* filler should be ignored */
 500                 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &filler));
 501
 502                 /*
 503                  * Private Header for Constructed Type
 504                  */
 505                 /* length - will be updated latter */
 506                 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
 507                 if (size_is >= 0 && size_is != content_size) {
 508                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 509                                               (int)size_is, (int)content_size);
 510                 }
 511                 /* the content size must be a multiple of 8 */
 512                 if ((content_size % 8) != 0) {
 513                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT,
 514                                               "Bad subcontext (PULL) size_is(%d) not padded to 8 content_size %d",
 515                                               (int)size_is, (int)content_size);
 516                 }
 517                 r_content_size = content_size;
 518
 519                 /* reserved */
 520                 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &reserved));
 521                 break;
 522         }
 523         default:
 524                 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) header_size %d",
 525                                       (int)header_size);
 526         }
 527
 528         NDR_PULL_NEED_BYTES(ndr, r_content_size);
 529
 530         subndr = talloc_zero(ndr, struct ndr_pull);
 531         NDR_ERR_HAVE_NO_MEMORY(subndr);
 532         subndr->flags           = ndr->flags;
 533         subndr->current_mem_ctx = ndr->current_mem_ctx;
 534
 535         subndr->data = ndr->data + ndr->offset;
 536         subndr->offset = 0;
 537         subndr->data_size = r_content_size;
 538         subndr->iconv_convenience = talloc_reference(subndr, ndr->iconv_convenience);
 539
 540         if (force_le) {
 541                 ndr_set_flags(&ndr->flags, LIBNDR_FLAG_LITTLE_ENDIAN);
 542         } else if (force_be) {
 543                 ndr_set_flags(&ndr->flags, LIBNDR_FLAG_BIGENDIAN);
 544         }
 545
 546         *_subndr = subndr;
 547         return NDR_ERR_SUCCESS;
 548 }
 549
 550 _PUBLIC_ enum ndr_err_code ndr_pull_subcontext_end(struct ndr_pull *ndr,
 551                                  struct ndr_pull *subndr,
 552                                  size_t header_size,
 553                                  ssize_t size_is)
 554 {
 555         uint32_t advance;
 556         if (size_is >= 0) {
 557                 advance = size_is;
 558         } else if (header_size > 0) {
 559                 advance = subndr->data_size;
 560         } else {
 561                 advance = subndr->offset;
 562         }
 563         NDR_CHECK(ndr_pull_advance(ndr, advance));
 564         return NDR_ERR_SUCCESS;
 565 }
 566
 567 _PUBLIC_ enum ndr_err_code ndr_push_subcontext_start(struct ndr_push *ndr,
 568                                    struct ndr_push **_subndr,
 569                                    size_t header_size,
 570                                    ssize_t size_is)
 571 {
 572         struct ndr_push *subndr;
 573
 574         subndr = ndr_push_init_ctx(ndr, ndr->iconv_convenience);
 575         NDR_ERR_HAVE_NO_MEMORY(subndr);
 576         subndr->flags   = ndr->flags;
 577
 578         if (size_is > 0) {
 579                 NDR_CHECK(ndr_push_zero(subndr, size_is));
 580                 subndr->offset = 0;
 581                 subndr->relative_end_offset = size_is;
 582         }
 583
 584         *_subndr = subndr;
 585         return NDR_ERR_SUCCESS;
 586 }
 587
 588 /*
 589   push a subcontext header
 590 */
 591 _PUBLIC_ enum ndr_err_code ndr_push_subcontext_end(struct ndr_push *ndr,
 592                                  struct ndr_push *subndr,
 593                                  size_t header_size,
 594                                  ssize_t size_is)
 595 {
 596         ssize_t padding_len;
 597
 598         if (size_is >= 0) {
 599                 padding_len = size_is - subndr->offset;
 600                 if (padding_len < 0) {
 601                         return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
 602                                               (int)subndr->offset, (int)size_is);
 603                 }
 604                 subndr->offset = size_is;
 605         }
 606
 607         switch (header_size) {
 608         case 0:
 609                 break;
 610
 611         case 2:
 612                 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, subndr->offset));
 613                 break;
 614
 615         case 4:
 616                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, subndr->offset));
 617                 break;
 618
 619         case 0xFFFFFC01:
 620                 /*
 621                  * Common Type Header for the Serialization Stream
 622                  * See [MS-RPCE] 2.2.6 Type Serialization Version 1
 623                  */
 624                 padding_len = NDR_ROUND(subndr->offset, 8) - subndr->offset;
 625                 if (padding_len > 0) {
 626                         NDR_CHECK(ndr_push_zero(subndr, padding_len));
 627                 }
 628
 629                 /* version */
 630                 NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, 1));
 631
 632                 /*
 633                  * 0x10 little endian
 634                  * 0x00 big endian
 635                  */
 636                 NDR_CHECK(ndr_push_uint8(ndr, NDR_SCALARS, NDR_BE(ndr)?0x00:0x10));
 637
 638                 /* length of the "Private Header for Constructed Type" */
 639                 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, 8));
 640
 641                 /* filler */
 642                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0xCCCCCCCC));
 643
 644                 /*
 645                  * Private Header for Constructed Type
 646                  */
 647                 /* length - will be updated latter */
 648                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, subndr->offset));
 649
 650                 /* reserved */
 651                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
 652                 break;
 653
 654         default:
 655                 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext header size %d",
 656                                       (int)header_size);
 657         }
 658
 659         NDR_CHECK(ndr_push_bytes(ndr, subndr->data, subndr->offset));
 660         return NDR_ERR_SUCCESS;
 661 }
 662
 663 /*
 664   store a token in the ndr context, for later retrieval
 665 */
 666 _PUBLIC_ enum ndr_err_code ndr_token_store(TALLOC_CTX *mem_ctx,
 667                          struct ndr_token_list **list,
 668                          const void *key,
 669                          uint32_t value)
 670 {
 671         struct ndr_token_list *tok;
 672         tok = talloc(mem_ctx, struct ndr_token_list);
 673         NDR_ERR_HAVE_NO_MEMORY(tok);
 674         tok->key = key;
 675         tok->value = value;
 676         DLIST_ADD((*list), tok);
 677         return NDR_ERR_SUCCESS;
 678 }
 679
 680 /*
 681   retrieve a token from a ndr context, using cmp_fn to match the tokens
 682 */
 683 _PUBLIC_ enum ndr_err_code ndr_token_retrieve_cmp_fn(struct ndr_token_list **list, const void *key, uint32_t *v,
 684                                    comparison_fn_t _cmp_fn, bool _remove_tok)
 685 {
 686         struct ndr_token_list *tok;
 687         for (tok=*list;tok;tok=tok->next) {
 688                 if (_cmp_fn && _cmp_fn(tok->key,key)==0) goto found;
 689                 else if (!_cmp_fn && tok->key == key) goto found;
 690         }
 691         return NDR_ERR_TOKEN;
 692 found:
 693         *v = tok->value;
 694         if (_remove_tok) {
 695                 DLIST_REMOVE((*list), tok);
 696                 talloc_free(tok);
 697         }
 698         return NDR_ERR_SUCCESS;
 699 }
 700
 701 /*
 702   retrieve a token from a ndr context
 703 */
 704 _PUBLIC_ enum ndr_err_code ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
 705 {
 706         return ndr_token_retrieve_cmp_fn(list, key, v, NULL, true);
 707 }
 708
 709 /*
 710   peek at but don't removed a token from a ndr context
 711 */
 712 _PUBLIC_ uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
 713 {
 714         enum ndr_err_code status;
 715         uint32_t v;
 716
 717         status = ndr_token_retrieve_cmp_fn(list, key, &v, NULL, false);
 718         if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
 719                 return 0;
 720         }
 721
 722         return v;
 723 }
 724
 725 /*
 726   pull an array size field and add it to the array_size_list token list
 727 */
 728 _PUBLIC_ enum ndr_err_code ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
 729 {
 730         uint32_t size;
 731         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
 732         return ndr_token_store(ndr, &ndr->array_size_list, p, size);
 733 }
 734
 735 /*
 736   get the stored array size field
 737 */
 738 _PUBLIC_ uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
 739 {
 740         return ndr_token_peek(&ndr->array_size_list, p);
 741 }
 742
 743 /*
 744   check the stored array size field
 745 */
 746 _PUBLIC_ enum ndr_err_code ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
 747 {
 748         uint32_t stored;
 749         stored = ndr_token_peek(&ndr->array_size_list, p);
 750         if (stored != size) {
 751                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 752                                       "Bad array size - got %u expected %u\n",
 753                                       stored, size);
 754         }
 755         return NDR_ERR_SUCCESS;
 756 }
 757
 758 /*
 759   pull an array length field and add it to the array_length_list token list
 760 */
 761 _PUBLIC_ enum ndr_err_code ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
 762 {
 763         uint32_t length, offset;
 764         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &offset));
 765         if (offset != 0) {
 766                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 767                                       "non-zero array offset %u\n", offset);
 768         }
 769         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
 770         return ndr_token_store(ndr, &ndr->array_length_list, p, length);
 771 }
 772
 773 /*
 774   get the stored array length field
 775 */
 776 _PUBLIC_ uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
 777 {
 778         return ndr_token_peek(&ndr->array_length_list, p);
 779 }
 780
 781 /*
 782   check the stored array length field
 783 */
 784 _PUBLIC_ enum ndr_err_code ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
 785 {
 786         uint32_t stored;
 787         stored = ndr_token_peek(&ndr->array_length_list, p);
 788         if (stored != length) {
 789                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 790                                       "Bad array length - got %u expected %u\n",
 791                                       stored, length);
 792         }
 793         return NDR_ERR_SUCCESS;
 794 }
 795
 796 /*
 797   store a switch value
 798  */
 799 _PUBLIC_ enum ndr_err_code ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val)
 800 {
 801         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 802 }
 803
 804 _PUBLIC_ enum ndr_err_code ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val)
 805 {
 806         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 807 }
 808
 809 _PUBLIC_ enum ndr_err_code ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val)
 810 {
 811         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 812 }
 813
 814 /*
 815   retrieve a switch value
 816  */
 817 _PUBLIC_ uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p)
 818 {
 819         return ndr_token_peek(&ndr->switch_list, p);
 820 }
 821
 822 _PUBLIC_ uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p)
 823 {
 824         return ndr_token_peek(&ndr->switch_list, p);
 825 }
 826
 827 _PUBLIC_ uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p)
 828 {
 829         return ndr_token_peek(&ndr->switch_list, p);
 830 }
 831
 832 /*
 833   pull a struct from a blob using NDR
 834 */
 835 _PUBLIC_ enum ndr_err_code ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, void *p,
 836                               ndr_pull_flags_fn_t fn)
 837 {
 838         struct ndr_pull *ndr;
 839         ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
 840         NDR_ERR_HAVE_NO_MEMORY(ndr);
 841         NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
 842         return NDR_ERR_SUCCESS;
 843 }
 844
 845 /*
 846   pull a struct from a blob using NDR - failing if all bytes are not consumed
 847 */
 848 _PUBLIC_ enum ndr_err_code ndr_pull_struct_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
 849                                                     struct smb_iconv_convenience *iconv_convenience,
 850                                                     void *p, ndr_pull_flags_fn_t fn)
 851 {
 852         struct ndr_pull *ndr;
 853         ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
 854         NDR_ERR_HAVE_NO_MEMORY(ndr);
 855         NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
 856         if (ndr->offset < ndr->data_size) {
 857                 return ndr_pull_error(ndr, NDR_ERR_UNREAD_BYTES,
 858                                       "not all bytes consumed ofs[%u] size[%u]",
 859                                       ndr->offset, ndr->data_size);
 860         }
 861         return NDR_ERR_SUCCESS;
 862 }
 863
 864 /*
 865   pull a union from a blob using NDR, given the union discriminator
 866 */
 867 _PUBLIC_ enum ndr_err_code ndr_pull_union_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
 868                                                struct smb_iconv_convenience *iconv_convenience, void *p,
 869                              uint32_t level, ndr_pull_flags_fn_t fn)
 870 {
 871         struct ndr_pull *ndr;
 872         ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
 873         NDR_ERR_HAVE_NO_MEMORY(ndr);
 874         NDR_CHECK(ndr_pull_set_switch_value(ndr, p, level));
 875         NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
 876         return NDR_ERR_SUCCESS;
 877 }
 878
 879 /*
 880   pull a union from a blob using NDR, given the union discriminator,
 881   failing if all bytes are not consumed
 882 */
 883 _PUBLIC_ enum ndr_err_code ndr_pull_union_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx,
 884                                                    struct smb_iconv_convenience *iconv_convenience, void *p,
 885                              uint32_t level, ndr_pull_flags_fn_t fn)
 886 {
 887         struct ndr_pull *ndr;
 888         ndr = ndr_pull_init_blob(blob, mem_ctx, iconv_convenience);
 889         NDR_ERR_HAVE_NO_MEMORY(ndr);
 890         NDR_CHECK(ndr_pull_set_switch_value(ndr, p, level));
 891         NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
 892         if (ndr->offset < ndr->data_size) {
 893                 return ndr_pull_error(ndr, NDR_ERR_UNREAD_BYTES,
 894                                       "not all bytes consumed ofs[%u] size[%u]",
 895                                       ndr->offset, ndr->data_size);
 896         }
 897         return NDR_ERR_SUCCESS;
 898 }
 899
 900 /*
 901   push a struct to a blob using NDR
 902 */
 903 _PUBLIC_ enum ndr_err_code ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, const void *p, ndr_push_flags_fn_t fn)
 904 {
 905         struct ndr_push *ndr;
 906         ndr = ndr_push_init_ctx(mem_ctx, iconv_convenience);
 907         NDR_ERR_HAVE_NO_MEMORY(ndr);
 908
 909         NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
 910
 911         *blob = ndr_push_blob(ndr);
 912         talloc_steal(mem_ctx, blob->data);
 913         talloc_free(ndr);
 914
 915         return NDR_ERR_SUCCESS;
 916 }
 917
 918 /*
 919   push a union to a blob using NDR
 920 */
 921 _PUBLIC_ enum ndr_err_code ndr_push_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, void *p,
 922                              uint32_t level, ndr_push_flags_fn_t fn)
 923 {
 924         struct ndr_push *ndr;
 925         ndr = ndr_push_init_ctx(mem_ctx, iconv_convenience);
 926         NDR_ERR_HAVE_NO_MEMORY(ndr);
 927
 928         NDR_CHECK(ndr_push_set_switch_value(ndr, p, level));
 929         NDR_CHECK(fn(ndr, NDR_SCALARS|NDR_BUFFERS, p));
 930
 931         *blob = ndr_push_blob(ndr);
 932         talloc_steal(mem_ctx, blob->data);
 933         talloc_free(ndr);
 934
 935         return NDR_ERR_SUCCESS;
 936 }
 937
 938 /*
 939   generic ndr_size_*() handler for structures
 940 */
 941 _PUBLIC_ size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push, struct smb_iconv_convenience *iconv_convenience)
 942 {
 943         struct ndr_push *ndr;
 944         enum ndr_err_code status;
 945         size_t ret;
 946
 947         /* avoid recursion */
 948         if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
 949
 950         ndr = ndr_push_init_ctx(NULL, iconv_convenience);
 951         if (!ndr) return 0;
 952         ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
 953         status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
 954         if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
 955                 talloc_free(ndr);
 956                 return 0;
 957         }
 958         ret = ndr->offset;
 959         talloc_free(ndr);
 960         return ret;
 961 }
 962
 963 /*
 964   generic ndr_size_*() handler for unions
 965 */
 966 _PUBLIC_ size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push, struct smb_iconv_convenience *iconv_convenience)
 967 {
 968         struct ndr_push *ndr;
 969         enum ndr_err_code status;
 970         size_t ret;
 971
 972         /* avoid recursion */
 973         if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
 974
 975         ndr = ndr_push_init_ctx(NULL, iconv_convenience);
 976         if (!ndr) return 0;
 977         ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
 978
 979         status = ndr_push_set_switch_value(ndr, p, level);
 980         if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
 981                 talloc_free(ndr);
 982                 return 0;
 983         }
 984         status = push(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 985         if (!NDR_ERR_CODE_IS_SUCCESS(status)) {
 986                 talloc_free(ndr);
 987                 return 0;
 988         }
 989         ret = ndr->offset;
 990         talloc_free(ndr);
 991         return ret;
 992 }
 993
 994 /*
 995   get the current base for relative pointers for the push
 996 */
 997 _PUBLIC_ uint32_t ndr_push_get_relative_base_offset(struct ndr_push *ndr)
 998 {
 999         return ndr->relative_base_offset;
1000 }
1001
1002 /*
1003   restore the old base for relative pointers for the push
1004 */
1005 _PUBLIC_ void ndr_push_restore_relative_base_offset(struct ndr_push *ndr, uint32_t offset)
1006 {
1007         ndr->relative_base_offset = offset;
1008 }
1009
1010 /*
1011   setup the current base for relative pointers for the push
1012   called in the NDR_SCALAR stage
1013 */
1014 _PUBLIC_ enum ndr_err_code ndr_push_setup_relative_base_offset1(struct ndr_push *ndr, const void *p, uint32_t offset)
1015 {
1016         ndr->relative_base_offset = offset;
1017         return ndr_token_store(ndr, &ndr->relative_base_list, p, offset);
1018 }
1019
1020 /*
1021   setup the current base for relative pointers for the push
1022   called in the NDR_BUFFERS stage
1023 */
1024 _PUBLIC_ enum ndr_err_code ndr_push_setup_relative_base_offset2(struct ndr_push *ndr, const void *p)
1025 {
1026         return ndr_token_retrieve(&ndr->relative_base_list, p, &ndr->relative_base_offset);
1027 }
1028
1029 /*
1030   push a relative object - stage1
1031   this is called during SCALARS processing
1032 */
1033 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p)
1034 {
1035         if (p == NULL) {
1036                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
1037                 return NDR_ERR_SUCCESS;
1038         }
1039         NDR_CHECK(ndr_push_align(ndr, 4));
1040         NDR_CHECK(ndr_token_store(ndr, &ndr->relative_list, p, ndr->offset));
1041         return ndr_push_uint32(ndr, NDR_SCALARS, 0xFFFFFFFF);
1042 }
1043
1044 /*
1045   push a relative object - stage2
1046   this is called during buffers processing
1047 */
1048 static enum ndr_err_code ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p)
1049 {
1050         uint32_t save_offset;
1051         uint32_t ptr_offset = 0xFFFFFFFF;
1052         if (p == NULL) {
1053                 return NDR_ERR_SUCCESS;
1054         }
1055         save_offset = ndr->offset;
1056         NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ptr_offset));
1057         if (ptr_offset > ndr->offset) {
1058                 return ndr_push_error(ndr, NDR_ERR_BUFSIZE,
1059                                       "ndr_push_relative_ptr2 ptr_offset(%u) > ndr->offset(%u)",
1060                                       ptr_offset, ndr->offset);
1061         }
1062         ndr->offset = ptr_offset;
1063         if (save_offset < ndr->relative_base_offset) {
1064                 return ndr_push_error(ndr, NDR_ERR_BUFSIZE,
1065                                       "ndr_push_relative_ptr2 save_offset(%u) < ndr->relative_base_offset(%u)",
1066                                       save_offset, ndr->relative_base_offset);
1067         }
1068         NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save_offset - ndr->relative_base_offset));
1069         ndr->offset = save_offset;
1070         return NDR_ERR_SUCCESS;
1071 }
1072
1073 /*
1074   push a relative object - stage2 start
1075   this is called during buffers processing
1076 */
1077 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr2_start(struct ndr_push *ndr, const void *p)
1078 {
1079         if (p == NULL) {
1080                 return NDR_ERR_SUCCESS;
1081         }
1082         if (!(ndr->flags & LIBNDR_FLAG_RELATIVE_REVERSE)) {
1083                 return ndr_push_relative_ptr2(ndr, p);
1084         }
1085
1086         return ndr_push_error(ndr, NDR_ERR_RELATIVE,
1087                               "ndr_push_relative_ptr2_start RELATIVE_REVERSE flag set, but not supported");
1088 }
1089
1090 /*
1091   push a relative object - stage2 end
1092   this is called during buffers processing
1093 */
1094 _PUBLIC_ enum ndr_err_code ndr_push_relative_ptr2_end(struct ndr_push *ndr, const void *p)
1095 {
1096         if (p == NULL) {
1097                 return NDR_ERR_SUCCESS;
1098         }
1099         return NDR_ERR_SUCCESS;
1100 }
1101
1102 /*
1103   get the current base for relative pointers for the pull
1104 */
1105 _PUBLIC_ uint32_t ndr_pull_get_relative_base_offset(struct ndr_pull *ndr)
1106 {
1107         return ndr->relative_base_offset;
1108 }
1109
1110 /*
1111   restore the old base for relative pointers for the pull
1112 */
1113 _PUBLIC_ void ndr_pull_restore_relative_base_offset(struct ndr_pull *ndr, uint32_t offset)
1114 {
1115         ndr->relative_base_offset = offset;
1116 }
1117
1118 /*
1119   setup the current base for relative pointers for the pull
1120   called in the NDR_SCALAR stage
1121 */
1122 _PUBLIC_ enum ndr_err_code ndr_pull_setup_relative_base_offset1(struct ndr_pull *ndr, const void *p, uint32_t offset)
1123 {
1124         ndr->relative_base_offset = offset;
1125         return ndr_token_store(ndr, &ndr->relative_base_list, p, offset);
1126 }
1127
1128 /*
1129   setup the current base for relative pointers for the pull
1130   called in the NDR_BUFFERS stage
1131 */
1132 _PUBLIC_ enum ndr_err_code ndr_pull_setup_relative_base_offset2(struct ndr_pull *ndr, const void *p)
1133 {
1134         return ndr_token_retrieve(&ndr->relative_base_list, p, &ndr->relative_base_offset);
1135 }
1136
1137 /*
1138   pull a relative object - stage1
1139   called during SCALARS processing
1140 */
1141 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
1142 {
1143         rel_offset += ndr->relative_base_offset;
1144         if (rel_offset > ndr->data_size) {
1145                 return ndr_pull_error(ndr, NDR_ERR_BUFSIZE,
1146                                       "ndr_pull_relative_ptr1 rel_offset(%u) > ndr->data_size(%u)",
1147                                       rel_offset, ndr->data_size);
1148         }
1149         return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
1150 }
1151
1152 /*
1153   pull a relative object - stage2
1154   called during BUFFERS processing
1155 */
1156 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p)
1157 {
1158         uint32_t rel_offset;
1159         NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
1160         return ndr_pull_set_offset(ndr, rel_offset);
1161 }
1162
1163 const static struct {
1164         enum ndr_err_code err;
1165         const char *string;
1166 } ndr_err_code_strings[] = {
1167         { NDR_ERR_SUCCESS, "Success" },
1168         { NDR_ERR_ARRAY_SIZE, "Bad Array Size" },
1169         { NDR_ERR_BAD_SWITCH, "Bad Switch" },
1170         { NDR_ERR_OFFSET, "Offset Error" },
1171         { NDR_ERR_RELATIVE, "Relative Pointer Error" },
1172         { NDR_ERR_CHARCNV, "Character Conversion Error" },
1173         { NDR_ERR_LENGTH, "Length Error" },
1174         { NDR_ERR_SUBCONTEXT, "Subcontext Error" },
1175         { NDR_ERR_COMPRESSION, "Compression Error" },
1176         { NDR_ERR_STRING, "String Error" },
1177         { NDR_ERR_VALIDATE, "Validate Error" },
1178         { NDR_ERR_BUFSIZE, "Buffer Size Error" },
1179         { NDR_ERR_ALLOC, "Allocation Error" },
1180         { NDR_ERR_RANGE, "Range Error" },
1181         { NDR_ERR_TOKEN, "Token Error" },
1182         { NDR_ERR_IPV4ADDRESS, "IPv4 Address Error" },
1183         { NDR_ERR_INVALID_POINTER, "Invalid Pointer" },
1184         { NDR_ERR_UNREAD_BYTES, "Unread Bytes" },
1185         { 0, NULL }
1186 };
1187
1188 _PUBLIC_ const char *ndr_map_error2string(enum ndr_err_code ndr_err)
1189 {
1190         int i;
1191         for (i = 0; ndr_err_code_strings[i].string != NULL; i++) {
1192                 if (ndr_err_code_strings[i].err == ndr_err)
1193                         return ndr_err_code_strings[i].string;
1194         }
1195         return "Unknown error";
1196 }