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 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 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(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 function calls via DEBUG()
 329 */
 330 void ndr_print_function_debug(ndr_print_function_t fn, const char *name, int flags, void *ptr)
 331 {
 332         struct ndr_print *ndr;
 333
 334         ndr = talloc(NULL, struct ndr_print);
 335         if (!ndr) return;
 336         ndr->print = ndr_print_debug_helper;
 337         ndr->depth = 1;
 338         ndr->flags = 0;
 339         fn(ndr, name, flags, ptr);
 340         talloc_free(ndr);
 341 }
 342
 343 void ndr_set_flags(uint32_t *pflags, uint32_t new_flags)
 344 {
 345         /* the big/little endian flags are inter-dependent */
 346         if (new_flags & LIBNDR_FLAG_LITTLE_ENDIAN) {
 347                 (*pflags) &= ~LIBNDR_FLAG_BIGENDIAN;
 348         }
 349         if (new_flags & LIBNDR_FLAG_BIGENDIAN) {
 350                 (*pflags) &= ~LIBNDR_FLAG_LITTLE_ENDIAN;
 351         }
 352         (*pflags) |= new_flags;
 353 }
 354
 355 static NTSTATUS ndr_map_error(enum ndr_err_code err)
 356 {
 357         switch (err) {
 358         case NDR_ERR_BUFSIZE:
 359                 return NT_STATUS_BUFFER_TOO_SMALL;
 360         case NDR_ERR_TOKEN:
 361                 return NT_STATUS_INTERNAL_ERROR;
 362         case NDR_ERR_ALLOC:
 363                 return NT_STATUS_NO_MEMORY;
 364         case NDR_ERR_ARRAY_SIZE:
 365                 return NT_STATUS_ARRAY_BOUNDS_EXCEEDED;
 366         default:
 367                 break;
 368         }
 369
 370         /* we should all error codes to different status codes */
 371         return NT_STATUS_INVALID_PARAMETER;
 372 }
 373
 374 /*
 375   return and possibly log an NDR error
 376 */
 377 NTSTATUS ndr_pull_error(struct ndr_pull *ndr,
 378                         enum ndr_err_code err, const char *format, ...) _PRINTF_ATTRIBUTE(3,4)
 379 {
 380         char *s=NULL;
 381         va_list ap;
 382
 383         va_start(ap, format);
 384         vasprintf(&s, format, ap);
 385         va_end(ap);
 386
 387         DEBUG(3,("ndr_pull_error(%u): %s\n", err, s));
 388
 389         free(s);
 390
 391         return ndr_map_error(err);
 392 }
 393
 394 /*
 395   return and possibly log an NDR error
 396 */
 397 NTSTATUS ndr_push_error(struct ndr_push *ndr, enum ndr_err_code err, const char *format, ...)  _PRINTF_ATTRIBUTE(3,4)
 398 {
 399         char *s=NULL;
 400         va_list ap;
 401
 402         va_start(ap, format);
 403         vasprintf(&s, format, ap);
 404         va_end(ap);
 405
 406         DEBUG(3,("ndr_push_error(%u): %s\n", err, s));
 407
 408         free(s);
 409
 410         return ndr_map_error(err);
 411 }
 412
 413
 414 /*
 415   handle subcontext buffers, which in midl land are user-marshalled, but
 416   we use magic in pidl to make them easier to cope with
 417 */
 418 NTSTATUS ndr_pull_subcontext_header(struct ndr_pull *ndr,
 419                                            size_t header_size,
 420                                            ssize_t size_is,
 421                                            struct ndr_pull *ndr2)
 422 {
 423         ndr2->flags = ndr->flags;
 424
 425         switch (header_size) {
 426         case 0: {
 427                 uint32_t content_size = ndr->data_size - ndr->offset;
 428                 if (size_is >= 0) {
 429                         content_size = size_is;
 430                 }
 431                 NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, content_size));
 432                 break;
 433         }
 434
 435         case 2: {
 436                 uint16_t content_size;
 437                 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &content_size));
 438                 if (size_is >= 0 && size_is != content_size) {
 439                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 440                                                 size_is, content_size);
 441                 }
 442                 NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, content_size));
 443                 break;
 444         }
 445
 446         case 4: {
 447                 uint32_t content_size;
 448                 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &content_size));
 449                 if (size_is >= 0 && size_is != content_size) {
 450                         return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) size_is(%d) mismatch content_size %d",
 451                                                 size_is, content_size);
 452                 }
 453                 NDR_CHECK(ndr_pull_subcontext(ndr, ndr2, content_size));
 454                 break;
 455         }
 456         default:
 457                 return ndr_pull_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PULL) header_size %d",
 458                                       header_size);
 459         }
 460         return NT_STATUS_OK;
 461 }
 462
 463 /*
 464   push a subcontext header
 465 */
 466 NTSTATUS ndr_push_subcontext_header(struct ndr_push *ndr,
 467                                            size_t header_size,
 468                                            ssize_t size_is,
 469                                            struct ndr_push *ndr2)
 470 {
 471         if (size_is >= 0) {
 472                 ssize_t padding_len = size_is - ndr2->offset;
 473                 if (padding_len > 0) {
 474                         NDR_CHECK(ndr_push_zero(ndr2, padding_len));
 475                 } else if (padding_len < 0) {
 476                         return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext (PUSH) content_size %d is larger than size_is(%d)",
 477                                               ndr2->offset, size_is);
 478                 }
 479         }
 480
 481         switch (header_size) {
 482         case 0:
 483                 break;
 484
 485         case 2:
 486                 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, ndr2->offset));
 487                 break;
 488
 489         case 4:
 490                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, ndr2->offset));
 491                 break;
 492
 493         default:
 494                 return ndr_push_error(ndr, NDR_ERR_SUBCONTEXT, "Bad subcontext header size %d",
 495                                       header_size);
 496         }
 497         return NT_STATUS_OK;
 498 }
 499
 500 /*
 501   mark the start of a structure
 502 */
 503 NTSTATUS ndr_pull_struct_start(struct ndr_pull *ndr)
 504 {
 505         return NT_STATUS_OK;
 506 }
 507
 508 /*
 509   mark the end of a structure
 510 */
 511 void ndr_pull_struct_end(struct ndr_pull *ndr)
 512 {
 513 }
 514
 515 /*
 516   mark the start of a structure
 517 */
 518 NTSTATUS ndr_push_struct_start(struct ndr_push *ndr)
 519 {
 520         return NT_STATUS_OK;
 521 }
 522
 523 /*
 524   mark the end of a structure
 525 */
 526 void ndr_push_struct_end(struct ndr_push *ndr)
 527 {
 528 }
 529
 530 /*
 531   store a token in the ndr context, for later retrieval
 532 */
 533 static NTSTATUS ndr_token_store(TALLOC_CTX *mem_ctx,
 534                                 struct ndr_token_list **list,
 535                                 const void *key,
 536                                 uint32_t value)
 537 {
 538         struct ndr_token_list *tok;
 539         tok = talloc(mem_ctx, struct ndr_token_list);
 540         if (tok == NULL) {
 541                 return NT_STATUS_NO_MEMORY;
 542         }
 543         tok->key = key;
 544         tok->value = value;
 545         DLIST_ADD((*list), tok);
 546         return NT_STATUS_OK;
 547 }
 548
 549 /*
 550   retrieve a token from a ndr context
 551 */
 552 static NTSTATUS ndr_token_retrieve(struct ndr_token_list **list, const void *key, uint32_t *v)
 553 {
 554         struct ndr_token_list *tok;
 555         for (tok=*list;tok;tok=tok->next) {
 556                 if (tok->key == key) {
 557                         DLIST_REMOVE((*list), tok);
 558                         *v = tok->value;
 559                         return NT_STATUS_OK;
 560                 }
 561         }
 562         return ndr_map_error(NDR_ERR_TOKEN);
 563 }
 564
 565 /*
 566   peek at but don't removed a token from a ndr context
 567 */
 568 static uint32_t ndr_token_peek(struct ndr_token_list **list, const void *key)
 569 {
 570         struct ndr_token_list *tok;
 571         for (tok=*list;tok;tok=tok->next) {
 572                 if (tok->key == key) {
 573                         return tok->value;
 574                 }
 575         }
 576         return 0;
 577 }
 578
 579 /*
 580   pull an array size field and add it to the array_size_list token list
 581 */
 582 NTSTATUS ndr_pull_array_size(struct ndr_pull *ndr, const void *p)
 583 {
 584         uint32_t size;
 585         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &size));
 586         return ndr_token_store(ndr, &ndr->array_size_list, p, size);
 587 }
 588
 589 /*
 590   get the stored array size field
 591 */
 592 uint32_t ndr_get_array_size(struct ndr_pull *ndr, const void *p)
 593 {
 594         return ndr_token_peek(&ndr->array_size_list, p);
 595 }
 596
 597 /*
 598   check the stored array size field
 599 */
 600 NTSTATUS ndr_check_array_size(struct ndr_pull *ndr, void *p, uint32_t size)
 601 {
 602         uint32_t stored;
 603         NDR_CHECK(ndr_token_retrieve(&ndr->array_size_list, p, &stored));
 604         if (stored != size) {
 605                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 606                                       "Bad array size - got %u expected %u\n",
 607                                       stored, size);
 608         }
 609         return NT_STATUS_OK;
 610 }
 611
 612 /*
 613   pull an array length field and add it to the array_length_list token list
 614 */
 615 NTSTATUS ndr_pull_array_length(struct ndr_pull *ndr, const void *p)
 616 {
 617         uint32_t length, offset;
 618         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &offset));
 619         if (offset != 0) {
 620                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 621                                       "non-zero array offset %u\n", offset);
 622         }
 623         NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
 624         return ndr_token_store(ndr, &ndr->array_length_list, p, length);
 625 }
 626
 627 /*
 628   get the stored array length field
 629 */
 630 uint32_t ndr_get_array_length(struct ndr_pull *ndr, const void *p)
 631 {
 632         return ndr_token_peek(&ndr->array_length_list, p);
 633 }
 634
 635 /*
 636   check the stored array length field
 637 */
 638 NTSTATUS ndr_check_array_length(struct ndr_pull *ndr, void *p, uint32_t length)
 639 {
 640         uint32_t stored;
 641         NDR_CHECK(ndr_token_retrieve(&ndr->array_length_list, p, &stored));
 642         if (stored != length) {
 643                 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE,
 644                                       "Bad array length - got %u expected %u\n",
 645                                       stored, length);
 646         }
 647         return NT_STATUS_OK;
 648 }
 649
 650 /*
 651   store a switch value
 652  */
 653 NTSTATUS ndr_push_set_switch_value(struct ndr_push *ndr, const void *p, uint32_t val)
 654 {
 655         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 656 }
 657
 658 NTSTATUS ndr_pull_set_switch_value(struct ndr_pull *ndr, const void *p, uint32_t val)
 659 {
 660         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 661 }
 662
 663 /*
 664   retrieve a switch value
 665  */
 666 uint32_t ndr_push_get_switch_value(struct ndr_push *ndr, const void *p)
 667 {
 668         return ndr_token_peek(&ndr->switch_list, p);
 669 }
 670
 671 uint32_t ndr_pull_get_switch_value(struct ndr_pull *ndr, const void *p)
 672 {
 673         return ndr_token_peek(&ndr->switch_list, p);
 674 }
 675
 676 NTSTATUS ndr_print_set_switch_value(struct ndr_print *ndr, const void *p, uint32_t val)
 677 {
 678         return ndr_token_store(ndr, &ndr->switch_list, p, val);
 679 }
 680
 681 /*
 682   retrieve a switch value
 683  */
 684 uint32_t ndr_print_get_switch_value(struct ndr_print *ndr, const void *p)
 685 {
 686         return ndr_token_peek(&ndr->switch_list, p);
 687 }
 688
 689 /*
 690   pull a relative object - stage1
 691   called during SCALARS processing
 692 */
 693 NTSTATUS ndr_pull_relative_ptr1(struct ndr_pull *ndr, const void *p, uint32_t rel_offset)
 694 {
 695         if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
 696                 return ndr_token_store(ndr, &ndr->relative_list, p,
 697                                        rel_offset + ndr->offset - 4);
 698         } else {
 699                 return ndr_token_store(ndr, &ndr->relative_list, p, rel_offset);
 700         }
 701 }
 702
 703 /*
 704   pull a relative object - stage2
 705   called during BUFFERS processing
 706 */
 707 NTSTATUS ndr_pull_relative_ptr2(struct ndr_pull *ndr, const void *p)
 708 {
 709         uint32_t rel_offset;
 710         NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &rel_offset));
 711         return ndr_pull_set_offset(ndr, rel_offset);
 712 }
 713
 714 /*
 715   push a relative object - stage1
 716   this is called during SCALARS processing
 717 */
 718 NTSTATUS ndr_push_relative_ptr1(struct ndr_push *ndr, const void *p)
 719 {
 720         if (p == NULL) {
 721                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
 722                 return NT_STATUS_OK;
 723         }
 724         NDR_CHECK(ndr_push_align(ndr, 4));
 725         NDR_CHECK(ndr_token_store(ndr, &ndr->relative_list, p, ndr->offset));
 726         return ndr_push_uint32(ndr, NDR_SCALARS, 0xFFFFFFFF);
 727 }
 728
 729 /*
 730   push a relative object - stage2
 731   this is called during buffers processing
 732 */
 733 NTSTATUS ndr_push_relative_ptr2(struct ndr_push *ndr, const void *p)
 734 {
 735         struct ndr_push_save save;
 736         if (p == NULL) {
 737                 return NT_STATUS_OK;
 738         }
 739         NDR_CHECK(ndr_push_align(ndr, 4));
 740         ndr_push_save(ndr, &save);
 741         NDR_CHECK(ndr_token_retrieve(&ndr->relative_list, p, &ndr->offset));
 742         if (ndr->flags & LIBNDR_FLAG_RELATIVE_CURRENT) {
 743                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save.offset - ndr->offset));
 744         } else {
 745                 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, save.offset));
 746         }
 747         ndr_push_restore(ndr, &save);
 748         return NT_STATUS_OK;
 749 }
 750
 751 /*
 752   pull a struct from a blob using NDR
 753 */
 754 NTSTATUS ndr_pull_struct_blob(const DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 755                               ndr_pull_flags_fn_t fn)
 756 {
 757         struct ndr_pull *ndr;
 758         ndr = ndr_pull_init_blob(blob, mem_ctx);
 759         if (!ndr) {
 760                 return NT_STATUS_NO_MEMORY;
 761         }
 762         return fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 763 }
 764
 765 /*
 766   push a struct to a blob using NDR
 767 */
 768 NTSTATUS ndr_push_struct_blob(DATA_BLOB *blob, TALLOC_CTX *mem_ctx, void *p,
 769                               ndr_push_flags_fn_t fn)
 770 {
 771         NTSTATUS status;
 772         struct ndr_push *ndr;
 773         ndr = ndr_push_init_ctx(mem_ctx);
 774         if (!ndr) {
 775                 return NT_STATUS_NO_MEMORY;
 776         }
 777         status = fn(ndr, NDR_SCALARS|NDR_BUFFERS, p);
 778         if (!NT_STATUS_IS_OK(status)) {
 779                 return status;
 780         }
 781
 782         *blob = ndr_push_blob(ndr);
 783
 784         return NT_STATUS_OK;
 785 }
 786
 787 /*
 788   generic ndr_size_*() handler for structures
 789 */
 790 size_t ndr_size_struct(const void *p, int flags, ndr_push_flags_fn_t push)
 791 {
 792         struct ndr_push *ndr;
 793         NTSTATUS status;
 794         size_t ret;
 795
 796         /* avoid recursion */
 797         if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
 798
 799         ndr = ndr_push_init_ctx(NULL);
 800         if (!ndr) return 0;
 801         ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
 802         status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
 803         if (!NT_STATUS_IS_OK(status)) {
 804                 return 0;
 805         }
 806         ret = ndr->offset;
 807         talloc_free(ndr);
 808         return ret;
 809 }
 810
 811 /*
 812   generic ndr_size_*() handler for unions
 813 */
 814 size_t ndr_size_union(const void *p, int flags, uint32_t level, ndr_push_flags_fn_t push)
 815 {
 816         struct ndr_push *ndr;
 817         NTSTATUS status;
 818         size_t ret;
 819
 820         /* avoid recursion */
 821         if (flags & LIBNDR_FLAG_NO_NDR_SIZE) return 0;
 822
 823         ndr = ndr_push_init_ctx(NULL);
 824         if (!ndr) return 0;
 825         ndr->flags |= flags | LIBNDR_FLAG_NO_NDR_SIZE;
 826         ndr_push_set_switch_value(ndr, p, level);
 827         status = push(ndr, NDR_SCALARS|NDR_BUFFERS, discard_const(p));
 828         if (!NT_STATUS_IS_OK(status)) {
 829                 return 0;
 830         }
 831         ret = ndr->offset;
 832         talloc_free(ndr);
 833         return ret;
 834 }