source4/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 2 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, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 /*
  24   this provides the core routines for NDR parsing functions
  25
  26   see http://www.opengroup.org/onlinepubs/9629399/chap14.htm for details
  27   of NDR encoding rules
  28 */
  29
  30 #include "includes.h"
  31 #include "dlinklist.h"
  32
  33 #define NDR_BASE_MARSHALL_SIZE 1024
  34
  35 /*
  36   work out the number of bytes needed to align on a n byte boundary
  37 */
  38 size_t ndr_align_size(uint32_t offset, size_t n)
  39 {
  40         if ((offset & (n-1)) == 0) return 0;
  41         return n - (offset & (n-1));
  42 }
  43
  44 /*
  45   initialise a ndr parse structure from a data blob
  46 */
  47 struct ndr_pull *ndr_pull_init_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
  48 {
  49         struct ndr_pull *ndr;
  50
  51         ndr = talloc_zero(mem_ctx, struct ndr_pull);
  52         if (!ndr) return NULL;
  53
  54         ndr->data = blob->data;
  55         ndr->data_size = blob->length;
  56
  57         return ndr;
  58 }
  59
  60 /*
  61   create an ndr sub-context based on an existing context. The new context starts
  62   at the current offset, with the given size limit
  63 */
  64 NTSTATUS ndr_pull_subcontext(struct ndr_pull *ndr, struct ndr_pull *ndr2, uint32_t size)
  65 {
  66         NDR_PULL_NEED_BYTES(ndr, size);
  67         *ndr2 = *ndr;
  68         ndr2->data += ndr2->offset;
  69         ndr2->offset = 0;
  70         ndr2->data_size = size;
  71         ndr2->flags = ndr->flags;
  72         return NT_STATUS_OK;
  73 }
  74
  75
  76 /*
  77   advance by 'size' bytes
  78 */
  79 NTSTATUS 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 NT_STATUS_OK;
  88 }
  89
  90 /*
  91   set the parse offset to 'ofs'
  92 */
  93 static NTSTATUS 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 NT_STATUS_OK;
 102 }
 103
 104 /* save the offset/size of the current ndr state */
 105 void ndr_pull_save(struct ndr_pull *ndr, struct ndr_pull_save *save)
 106 {
 107         save->offset = ndr->offset;
 108         save->data_size = ndr->data_size;
 109 }
 110
 111 /* restore the size/offset of a ndr structure */
 112 void ndr_pull_restore(struct ndr_pull *ndr, struct ndr_pull_save *save)
 113 {
 114         ndr->offset = save->offset;
 115         ndr->data_size = save->data_size;
 116 }
 117
 118
 119 /* create a ndr_push structure, ready for some marshalling */
 120 struct ndr_push *ndr_push_init_ctx(TALLOC_CTX *mem_ctx)
 121 {
 122         struct ndr_push *ndr;
 123
 124         ndr = talloc_zero(mem_ctx, struct ndr_push);
 125         if (!ndr) {
 126                 return NULL;
 127         }
 128
 129         ndr->flags = 0;
 130         ndr->alloc_size = NDR_BASE_MARSHALL_SIZE;
 131         ndr->data = talloc_array(ndr, uint8_t, ndr->alloc_size);
 132         if (!ndr->data) {
 133                 return NULL;
 134         }
 135
 136         return ndr;
 137 }
 138
 139
 140 /* create a ndr_push structure, ready for some marshalling */
 141 struct ndr_push *ndr_push_init(void)
 142 {
 143         return ndr_push_init_ctx(NULL);
 144 }
 145
 146 /* free a ndr_push structure */
 147 void ndr_push_free(struct ndr_push *ndr)
 148 {
 149         talloc_free(ndr);
 150 }
 151
 152
 153 /* return a DATA_BLOB structure for the current ndr_push marshalled data */
 154 DATA_BLOB ndr_push_blob(struct ndr_push *ndr)
 155 {
 156         DATA_BLOB blob;
 157         blob.data = ndr->data;
 158         blob.length = ndr->offset;
 159         return blob;
 160 }
 161
 162
 163 /*
 164   expand the available space in the buffer to 'size'
 165 */
 166 NTSTATUS ndr_push_expand(struct ndr_push *ndr, uint32_t size)
 167 {
 168         if (ndr->alloc_size >= size) {
 169                 return NT_STATUS_OK;
 170         }
 171
 172         ndr->alloc_size += NDR_BASE_MARSHALL_SIZE;
 173         if (size > ndr->alloc_size) {
 174                 ndr->alloc_size = size;
 175         }
 176         ndr->data = talloc_realloc(ndr, ndr->data, uint8_t, ndr->alloc_size);
 177         if (!ndr->data) {
 178                 return ndr_push_error(ndr, NDR_ERR_ALLOC, "Failed to push_expand to %u",
 179                                       ndr->alloc_size);
 180         }
 181
 182         return NT_STATUS_OK;
 183 }
 184
 185 /*
 186   set the push offset to 'ofs'
 187 */
 188 static NTSTATUS ndr_push_set_offset(struct ndr_push *ndr, uint32_t ofs)
 189 {
 190         NDR_CHECK(ndr_push_expand(ndr, ofs));
 191         ndr->offset = ofs;
 192         return NT_STATUS_OK;
 193 }
 194
 195 /*
 196   push a generic array
 197 */
 198 NTSTATUS ndr_push_array(struct ndr_push *ndr, int ndr_flags, void *base,
 199                         size_t elsize, uint32_t count,
 200                         NTSTATUS (*push_fn)(struct ndr_push *, int, void *))
 201 {
 202         int i;
 203         char *p = base;
 204         if (!(ndr_flags & NDR_SCALARS)) goto buffers;
 205         for (i=0;i<count;i++) {
 206                 NDR_CHECK(push_fn(ndr, NDR_SCALARS, p));
 207                 p += elsize;
 208         }
 209         if (!(ndr_flags & NDR_BUFFERS)) goto done;
 210 buffers:
 211         p = base;
 212         for (i=0;i<count;i++) {
 213                 NDR_CHECK(push_fn(ndr, NDR_BUFFERS, p));
 214                 p += elsize;
 215         }
 216 done:
 217         return NT_STATUS_OK;
 218 }
 219
 220 /*
 221   pull a constant sized array
 222 */
 223 NTSTATUS ndr_pull_array(struct ndr_pull *ndr, int ndr_flags, void *base,
 224                         size_t elsize, uint32_t count,
 225                         NTSTATUS (*pull_fn)(struct ndr_pull *, int, void *))
 226 {
 227         int i;
 228         char *p;
 229         p = base;
 230         if (!(ndr_flags & NDR_SCALARS)) goto buffers;
 231         for (i=0;i<count;i++) {
 232                 NDR_CHECK(pull_fn(ndr, NDR_SCALARS, p));
 233                 p += elsize;
 234         }
 235         if (!(ndr_flags & NDR_BUFFERS)) goto done;
 236 buffers:
 237         p = base;
 238         for (i=0;i<count;i++) {
 239                 NDR_CHECK(pull_fn(ndr, NDR_BUFFERS, p));
 240                 p += elsize;
 241         }
 242 done:
 243         return NT_STATUS_OK;
 244 }
 245
 246 /*
 247   pull a constant size array of structures
 248 */
 249 NTSTATUS ndr_pull_struct_array(struct ndr_pull *ndr, uint32_t count,
 250                                size_t elsize, void **info,
 251                                NTSTATUS (*pull_fn)(struct ndr_pull *, int, void *))
 252 {
 253         int i;
 254         char *base;
 255
 256         NDR_ALLOC_N_SIZE(ndr, *info, count, elsize);
 257         base = (char *)*info;
 258
 259         for (i = 0; i < count; i++) {
 260                 ndr->data += ndr->offset;
 261                 ndr->offset = 0;
 262                 NDR_CHECK(pull_fn(ndr, NDR_SCALARS|NDR_BUFFERS, &base[count * elsize]));
 263         }
 264
 265         return NT_STATUS_OK;
 266 }
 267
 268 /*
 269   print a generic array
 270 */
 271 void ndr_print_array(struct ndr_print *ndr, const char *name, void *base,
 272                      size_t elsize, uint32_t count,
 273                      void (*print_fn)(struct ndr_print *, const char *, void *))
 274 {
 275         int i;
 276         char *p = base;
 277         ndr->print(ndr, "%s: ARRAY(%d)", name, count);
 278         ndr->depth++;
 279         for (i=0;i<count;i++) {
 280                 char *idx=NULL;
 281                 asprintf(&idx, "[%d]", i);
 282                 if (idx) {
 283                         print_fn(ndr, idx, p);
 284                         free(idx);
 285                 }
 286                 p += elsize;
 287         }
 288         ndr->depth--;
 289 }
 290
 291
 292
 293 void ndr_print_debug_helper(struct ndr_print *ndr, const char *format, ...) _PRINTF_ATTRIBUTE(2,3)
 294 {
 295         va_list ap;
 296         char *s = NULL;
 297         int i;
 298
 299         va_start(ap, format);
 300         vasprintf(&s, format, ap);
 301         va_end(ap);
 302
 303         for (i=0;i<ndr->depth;i++) {
 304                 DEBUG(0,("    "));
 305         }
 306
 307         DEBUG(0,("%s\n", s));
 308         free(s);
 309 }
 310
 311 /*
 312   a useful helper function for printing idl structures via DEBUG()
 313 */
 314 void ndr_print_debug(ndr_print_fn_t fn, const char *name, void *ptr)
 315 {
 316         struct ndr_print *ndr;
 317
 318         ndr = talloc_zero(NULL, struct ndr_print);
 319         if (!ndr) return;
 320         ndr->print = ndr_print_debug_helper;
 321         ndr->depth = 1;
 322         ndr->flags = 0;
 323         fn(ndr, name, ptr);
 324         talloc_free(ndr);
 325 }
 326
 327 /*
 328   a useful helper function for printing idl unions via DEBUG()
 329 */
 330 void ndr_print_union_debug(ndr_print_fn_t fn, const char *name, uint32_t level, void *ptr)
 331 {
 332         struct ndr_print *ndr;
 333
 334         ndr = talloc_zero(NULL, struct ndr_print);
 335         if (!ndr) return;
 336         ndr->print = ndr_print_debug_helper;
 337         ndr->depth = 1;
 338         ndr->flags = 0;
 339         ndr_print_set_switch_value(ndr, ptr, level);
 340         fn(ndr, name, ptr);
 341         talloc_free(ndr);
 342 }
 343
 344 /*
 345   a useful helper function for printing idl function calls via DEBUG()
 346 */
 347 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr)
 348 {
 349         struct ndr_print *ndr;
 350
 351         ndr = talloc_zero(NULL, struct ndr_print);
 352         if (!ndr) return;
 353         ndr->print = ndr_print_debug_helper;
 354         ndr->depth = 1;
 355         ndr->flags = 0;
 356         fn(ndr, name, flags, ptr);
 357         talloc_free(ndr);
 358 }
 359
 360 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags)
 361 {
 362         /* the big/little endian flags are inter-dependent */
 363         if (new_flags & LIBNDR_FLAG_LITTLE_ENDIAN) {
 364                 (*pflags) &= ~LIBNDR_FLAG_BIGENDIAN;
 365         }
 366         if (new_flags & LIBNDR_FLAG_BIGENDIAN) {
 367                 (*pflags) &= ~LIBNDR_FLAG_LITTLE_ENDIAN;
 368         }
 369         (*pflags) |= new_flags;
 370 }
 371
 372 static NTSTATUS ndr_map_error(enum ndr_err_code err)
 373 {
 374         switch (err) {
 375         case NDR_ERR_BUFSIZE:
 376                 return NT_STATUS_BUFFER_TOO_SMALL;
 377         case NDR_ERR_TOKEN:
 378                 return NT_STATUS_INTERNAL_ERROR;
 379         case NDR_ERR_ALLOC:
 380                 return NT_STATUS_NO_MEMORY;
 381         case NDR_ERR_ARRAY_SIZE:
 382                 return NT_STATUS_ARRAY_BOUNDS_EXCEEDED;
 383         default:
 384                 break;
 385         }
 386
 387         /* we should all error codes to different status codes */
 388         return NT_STATUS_INVALID_PARAMETER;
 389 }
 390
 391 /*
 392   return and possibly log an NDR error
 393 */
 394 NTSTATUS ndr_pull_error(struct ndr_pull *ndr,
 395                         enum ndr_err_code err, const char *format, ...) _PRINTF_ATTRIBUTE(3,4)
 396 {
 397         char *s=NULL;
 398         va_list ap;
 399
 400         va_start(ap, format);
 401         vasprintf(&s, format, ap);
 402         va_end(ap);
 403
 404         DEBUG(3,("ndr_pull_error(%u): %s\n", err, s));
 405
 406         free(s);
 407
 408         return ndr_map_error(err);
 409 }
 410
 411 /*
 412   return and possibly log an NDR error
 413 */
 414 NTSTATUS ndr_push_error(struct ndr_push *ndr, enum ndr_err_code err, const char *format, ...)  _PRINTF_ATTRIBUTE(3,4)
 415 {
 416         char *s=NULL;
 417         va_list ap;
 418
 419         va_start(ap, format);
 420         vasprintf(&s, format, ap);
 421         va_end(ap);
 422
 423         DEBUG(3,("ndr_push_error(%u): %s\n", err, s));
 424
 425         free(s);
 426
 427         return ndr_map_error(err);
 428 }
 429
 430
 431 /*
 432   handle subcontext buffers, which in midl land are user-marshalled, but
 433   we use magic in pidl to make them easier to cope with
 434 */
 435 NTSTATUS ndr_pull_subcontext_header(struct ndr_pull *ndr,
 436                                            size_t header_size,
 437                                            ssize_t size_is,
 438                                            struct ndr_pull *ndr2)
 439 {
 440         ndr2->flags = ndr->flags;
 441
 442         switch (header_size) {
 443         case 0: {
 444                 uint32_t content_size = ndr->data_size - ndr->offset;
 445                 if (size_is >= 0) {
 446                         content_size = size_is;
 447                 }
 448                 NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, content_size));
 449                 break;
 450         }
 451
 452         case 2: {
 453                 uint16_t content_size;
 454                 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &content_size));
 455                 if (size_is >= 0 && size_is != content_size) {
 456                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 457                                                 size_is, content_size);
 458                 }
 459                 NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, content_size));
 460                 break;
 461         }
 462
 463         case 4: {
 464                 uint32_t content_size;
 465                 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
 466                 if (size_is >= 0 && size_is != content_size) {
 467                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 468                                                 size_is, content_size);
 469                 }
 470                 NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, content_size));
 471                 break;
 472         }
 473         default:
 474                 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) header_size %d",
 475                                       header_size);
 476         }
 477         return NT_STATUS_OK;
 478 }
 479
 480 /*
 481   push a subcontext header
 482 */
 483 NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr,
 484                                            size_t header_size,
 485                                            ssize_t size_is,
 486                                            struct ndr_push *ndr2)
 487 {
 488         if (size_is >= 0) {
 489                 ssize_t padding_len = size_is - ndr2->offset;
 490                 if (padding_len > 0) {
 491                         NDR_CHECK(ndr_push_zero(ndr2, padding_len));
 492                 } else if (padding_len < 0) {
 493                         return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
 494                                               ndr2->offset, size_is);
 495                 }
 496         }
 497
 498         switch (header_size) {
 499         case 0:
 500                 break;
 501
 502         case 2:
 503                 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, ndr2->offset));
 504                 break;
 505
 506         case 4:
 507                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr2->offset));
 508                 break;
 509
 510         default:
 511                 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext header size %d",
 512                                       header_size);
 513         }
 514         return NT_STATUS_OK;
 515 }
 516
 517 /*
 518   mark the start of a structure
 519 */
 520 NTSTATUS ndr_pull_struct_start(struct ndr_pull *ndr)
 521 {
 522         return NT_STATUS_OK;
 523 }
 524
 525 /*
 526   mark the end of a structure
 527 */
 528 void ndr_pull_struct_end(struct ndr_pull *ndr)
 529 {
 530 }
 531
 532 /*
 533   mark the start of a structure
 534 */
 535 NTSTATUS ndr_push_struct_start(struct ndr_push *ndr)
 536 {
 537         return NT_STATUS_OK;
 538 }
 539
 540 /*
 541   mark the end of a structure
 542 */
 543 void ndr_push_struct_end(struct ndr_push *ndr)
 544 {
 545 }
 546
 547 /*
 548   store a token in the ndr context, for later retrieval
 549 */
 550 static NTSTATUS ndr_token_store(TALLOC_CTX *mem_ctx,
 551                                 struct ndr_token_list **list,
 552                                 const void *key,
 553                                 uint32_t value)
 554 {
 555         struct ndr_token_list *tok;
 556         tok = talloc(mem_ctx, struct ndr_token_list);
 557         if (tok == NULL) {
 558                 return NT_STATUS_NO_MEMORY;
 559         }
 560         tok->key = key;
 561         tok->value = value;
 562         DLIST_ADD((*list), tok);
 563         return NT_STATUS_OK;
 564 }
 565
 566 /*
 567   retrieve a token from a ndr context
 568 */
 569 static NTSTATUS ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
 570 {
 571         struct ndr_token_list *tok;
 572         for (tok=*list;tok;tok=tok->next) {
 573                 if (tok->key == key) {
 574                         DLIST_REMOVE((*list), tok);
 575                         *v = tok->value;
 576                         return NT_STATUS_OK;
 577                 }
 578         }
 579         return ndr_map_error(NDR_ERR_TOKEN);
 580 }
 581
 582 /*
 583   peek at but don't removed a token from a ndr context
 584 */
 585 static uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
 586 {
 587         struct ndr_token_list *tok;
 588         for (tok=*list;tok;tok=tok->next) {
 589                 if (tok->key == key) {
 590                         return tok->value;
 591                 }
 592         }
 593         return 0;
 594 }
 595
 596 /*
 597   pull an array size field and add it to the array_size_list token list
 598 */
 599 NTSTATUS ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
 600 {
 601         uint32_t size;
 602         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
 603         return ndr_token_store(ndr, &ndr->array_size_list, p, size);
 604 }
 605
 606 /*
 607   get the stored array size field
 608 */
 609 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
 610 {
 611         return ndr_token_peek(&ndr->array_size_list, p);
 612 }
 613
 614 /*
 615   check the stored array size field
 616 */
 617 NTSTATUS ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
 618 {
 619         uint32_t stored;
 620         NDR_CHECK(ndr_token_retrieve(&ndr->array_size_list, p, &stored));
 621         if (stored != size) {
 622                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 623                                       "Bad array size - got %u expected %u\n",
 624                                       stored, size);
 625         }
 626         return NT_STATUS_OK;
 627 }
 628
 629 /*
 630   pull an array length field and add it to the array_length_list token list
 631 */
 632 NTSTATUS ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
 633 {
 634         uint32_t length, offset;
 635         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &offset));
 636         if (offset != 0) {
 637                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 638                                       "non-zero array offset %u\n", offset);
 639         }
 640         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
 641         return ndr_token_store(ndr, &ndr->array_length_list, p, length);
 642 }
 643
 644 /*
 645   get the stored array length field
 646 */
 647 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
 648 {
 649         return ndr_token_peek(&ndr->array_length_list, p);
 650 }
 651
 652 /*
 653   check the stored array length field
 654 */
 655 NTSTATUS ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
 656 {
 657         uint32_t stored;
 658         NDR_CHECK(ndr_token_retrieve(&ndr->array_length_list, p, &stored));
 659         if (stored != length) {
 660                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 661                                       "Bad array length - got %u expected %u\n",
 662                                       stored, length);
 663         }
 664         return NT_STATUS_OK;
 665 }
 666
 667 /*
 668   store a switch value
 669  */
 670 NTSTATUS ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val)
 671 {
 672         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 673 }
 674
 675 NTSTATUS ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val)
 676 {
 677         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 678 }
 679
 680 NTSTATUS ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val)
 681 {
 682         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 683 }
 684
 685 /*
 686   retrieve a switch value
 687  */
 688 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p)
 689 {
 690         return ndr_token_peek(&ndr->switch_list, p);
 691 }
 692
 693 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p)
 694 {
 695         return ndr_token_peek(&ndr->switch_list, p);
 696 }
 697
 698 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p)
 699 {
 700         return ndr_token_peek(&ndr->switch_list, p);
 701 }
 702
 703 /*
 704   pull a relative object - stage1
 705   called during SCALARS processing
 706 */
 707 NTSTATUS ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
 708 {
 709         if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
 710                 return ndr_token_store(ndr, &ndr->relative_list, p,
 711                                        rel_offset + ndr->offset - 4);
 712         } else {
 713                 return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
 714         }
 715 }
 716
 717 /*
 718   pull a relative object - stage2
 719   called during BUFFERS processing
 720 */
 721 NTSTATUS ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p)
 722 {
 723         uint32_t rel_offset;
 724         NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
 725         return ndr_pull_set_offset(ndr, rel_offset);
 726 }
 727
 728 /*
 729   push a relative object - stage1
 730   this is called during SCALARS processing
 731 */
 732 NTSTATUS ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p)
 733 {
 734         if (p == NULL) {
 735                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
 736                 return NT_STATUS_OK;
 737         }
 738         NDR_CHECK(ndr_push_align(ndr, 4));
 739         NDR_CHECK(ndr_token_store(ndr, &ndr->relative_list, p, ndr->offset));
 740         return ndr_push_uint32(ndr, NDR_SCALARS, 0xFFFFFFFF);
 741 }
 742
 743 /*
 744   push a relative object - stage2
 745   this is called during buffers processing
 746 */
 747 NTSTATUS ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p)
 748 {
 749         struct ndr_push_save save;
 750         if (p == NULL) {
 751                 return NT_STATUS_OK;
 752         }
 753         NDR_CHECK(ndr_push_align(ndr, 4));
 754         ndr_push_save(ndr, &save);
 755         NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ndr->offset));
 756         if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
 757                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save.offset - ndr->offset));
 758         } else {
 759                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save.offset));
 760         }
 761         ndr_push_restore(ndr, &save);
 762         return NT_STATUS_OK;
 763 }
 764
 765 /*
 766   pull a struct from a blob using NDR
 767 */
 768 NTSTATUS ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 769                               ndr_pull_flags_fn_t fn)
 770 {
 771         struct ndr_pull *ndr;
 772         ndr = ndr_pull_init_blob(blob, mem_ctx);
 773         if (!ndr) {
 774                 return NT_STATUS_NO_MEMORY;
 775         }
 776         return fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 777 }
 778
 779 /*
 780   pull a struct from a blob using NDR - failing if all bytes are not consumed
 781 */
 782 NTSTATUS ndr_pull_struct_blob_all(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 783                                   ndr_pull_flags_fn_t fn)
 784 {
 785         struct ndr_pull *ndr;
 786         NTSTATUS status;
 787
 788         ndr = ndr_pull_init_blob(blob, mem_ctx);
 789         if (!ndr) {
 790                 return NT_STATUS_NO_MEMORY;
 791         }
 792         status = fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 793         if (!NT_STATUS_IS_OK(status)) return status;
 794         if (ndr->offset != ndr->data_size) {
 795                 return NT_STATUS_BUFFER_TOO_SMALL;
 796         }
 797         return status;
 798 }
 799
 800 /*
 801   pull a union from a blob using NDR, given the union discriminator
 802 */
 803 NTSTATUS ndr_pull_union_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 804                              uint32_t level, ndr_pull_flags_fn_t fn)
 805 {
 806         struct ndr_pull *ndr;
 807         NTSTATUS status;
 808
 809         ndr = ndr_pull_init_blob(blob, mem_ctx);
 810         if (!ndr) {
 811                 return NT_STATUS_NO_MEMORY;
 812         }
 813         ndr_pull_set_switch_value(ndr, p, level);
 814         status = fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 815         if (!NT_STATUS_IS_OK(status)) return status;
 816         if (ndr->offset != ndr->data_size) {
 817                 return NT_STATUS_BUFFER_TOO_SMALL;
 818         }
 819         return status;
 820 }
 821
 822 /*
 823   push a struct to a blob using NDR
 824 */
 825 NTSTATUS ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 826                               ndr_push_flags_fn_t fn)
 827 {
 828         NTSTATUS status;
 829         struct ndr_push *ndr;
 830         ndr = ndr_push_init_ctx(mem_ctx);
 831         if (!ndr) {
 832                 return NT_STATUS_NO_MEMORY;
 833         }
 834         status = fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 835         if (!NT_STATUS_IS_OK(status)) {
 836                 return status;
 837         }
 838
 839         *blob = ndr_push_blob(ndr);
 840
 841         return NT_STATUS_OK;
 842 }
 843
 844 /*
 845   push a union to a blob using NDR
 846 */
 847 NTSTATUS ndr_push_union_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 848                              uint32_t level, ndr_push_flags_fn_t fn)
 849 {
 850         NTSTATUS status;
 851         struct ndr_push *ndr;
 852         ndr = ndr_push_init_ctx(mem_ctx);
 853         if (!ndr) {
 854                 return NT_STATUS_NO_MEMORY;
 855         }
 856         ndr_push_set_switch_value(ndr, p, level);
 857         status = fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 858         if (!NT_STATUS_IS_OK(status)) {
 859                 return status;
 860         }
 861
 862         *blob = ndr_push_blob(ndr);
 863
 864         return NT_STATUS_OK;
 865 }
 866
 867 /*
 868   generic ndr_size_*() handler for structures
 869 */
 870 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push)
 871 {
 872         struct ndr_push *ndr;
 873         NTSTATUS status;
 874         size_t ret;
 875
 876         /* avoid recursion */
 877         if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
 878
 879         ndr = ndr_push_init_ctx(NULL);
 880         if (!ndr) return 0;
 881         ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
 882         status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
 883         if (!NT_STATUS_IS_OK(status)) {
 884                 return 0;
 885         }
 886         ret = ndr->offset;
 887         talloc_free(ndr);
 888         return ret;
 889 }
 890
 891 /*
 892   generic ndr_size_*() handler for unions
 893 */
 894 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push)
 895 {
 896         struct ndr_push *ndr;
 897         NTSTATUS status;
 898         size_t ret;
 899
 900         /* avoid recursion */
 901         if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
 902
 903         ndr = ndr_push_init_ctx(NULL);
 904         if (!ndr) return 0;
 905         ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
 906         ndr_push_set_switch_value(ndr, p, level);
 907         status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
 908         if (!NT_STATUS_IS_OK(status)) {
 909                 return 0;
 910         }
 911         ret = ndr->offset;
 912         talloc_free(ndr);
 913         return ret;
 914 }