2 Unix SMB/CIFS implementation.
4 routines for marshalling/unmarshalling basic types
6 Copyright (C) Andrew Tridgell 2003
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.
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.
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.
25 /* Evil hack to convert Samba3 NTTIME's to Samba4 NTTIME's */
34 #define NDR_SVAL(ndr, ofs) (NDR_BE(ndr)?RSVAL(ndr->data,ofs):SVAL(ndr->data,ofs))
35 #define NDR_IVAL(ndr, ofs) (NDR_BE(ndr)?RIVAL(ndr->data,ofs):IVAL(ndr->data,ofs))
36 #define NDR_IVALS(ndr, ofs) (NDR_BE(ndr)?RIVALS(ndr->data,ofs):IVALS(ndr->data,ofs))
37 #define NDR_SSVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSSVAL(ndr->data,ofs,v); } else SSVAL(ndr->data,ofs,v); } while (0)
38 #define NDR_SIVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVAL(ndr->data,ofs,v); } else SIVAL(ndr->data,ofs,v); } while (0)
39 #define NDR_SIVALS(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVALS(ndr->data,ofs,v); } else SIVALS(ndr->data,ofs,v); } while (0)
43 check for data leaks from the server by looking for non-zero pad bytes
44 these could also indicate that real structure elements have been
45 mistaken for padding in the IDL
47 void ndr_check_padding(struct ndr_pull *ndr, size_t n)
49 size_t ofs2 = (ndr->offset + (n-1)) & ~(n-1);
51 for (i=ndr->offset;i<ofs2;i++) {
52 if (ndr->data[i] != 0) {
57 DEBUG(0,("WARNING: Non-zero padding to %d: ", (int)n));
58 for (i=ndr->offset;i<ofs2;i++) {
59 DEBUG(0,("%02x ", ndr->data[i]));
69 NTSTATUS ndr_pull_int8(struct ndr_pull *ndr, int ndr_flags, int8_t *v)
71 NDR_PULL_NEED_BYTES(ndr, 1);
72 *v = (int8_t)CVAL(ndr->data, ndr->offset);
80 NTSTATUS ndr_pull_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
82 NDR_PULL_NEED_BYTES(ndr, 1);
83 *v = CVAL(ndr->data, ndr->offset);
91 NTSTATUS ndr_pull_int16(struct ndr_pull *ndr, int ndr_flags, int16_t *v)
93 NDR_PULL_ALIGN(ndr, 2);
94 NDR_PULL_NEED_BYTES(ndr, 2);
95 *v = (uint16_t)NDR_SVAL(ndr, ndr->offset);
103 NTSTATUS ndr_pull_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
105 NDR_PULL_ALIGN(ndr, 2);
106 NDR_PULL_NEED_BYTES(ndr, 2);
107 *v = NDR_SVAL(ndr, ndr->offset);
115 NTSTATUS ndr_pull_int32(struct ndr_pull *ndr, int ndr_flags, int32_t *v)
117 NDR_PULL_ALIGN(ndr, 4);
118 NDR_PULL_NEED_BYTES(ndr, 4);
119 *v = NDR_IVALS(ndr, ndr->offset);
127 NTSTATUS ndr_pull_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
129 NDR_PULL_ALIGN(ndr, 4);
130 NDR_PULL_NEED_BYTES(ndr, 4);
131 *v = NDR_IVAL(ndr, ndr->offset);
137 parse a pointer referent identifier
139 NTSTATUS ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v)
142 status = ndr_pull_uint32(ndr, NDR_SCALARS, v);
143 if (NT_STATUS_IS_OK(status) && *v != 0) {
150 parse a ref pointer referent identifier
152 NTSTATUS ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
154 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
155 /* ref pointers always point to data */
163 NTSTATUS ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
165 NDR_PULL_ALIGN(ndr, 4);
166 NDR_PULL_NEED_BYTES(ndr, 8);
167 *v = NDR_IVAL(ndr, ndr->offset);
168 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
176 NTSTATUS ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
178 NDR_PULL_ALIGN(ndr, 4);
179 NDR_PULL_NEED_BYTES(ndr, 8);
180 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
181 *v |= NDR_IVAL(ndr, ndr->offset+4);
189 NTSTATUS ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
191 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
197 NTSTATUS ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
199 NDR_PULL_ALIGN(ndr, 8);
200 return ndr_pull_udlong(ndr, ndr_flags, v);
206 NTSTATUS ndr_pull_pointer(struct ndr_pull *ndr, int ndr_flags, void* *v)
209 NDR_PULL_ALIGN(ndr, sizeof(h));
210 NDR_PULL_NEED_BYTES(ndr, sizeof(h));
211 memcpy(&h, ndr->data+ndr->offset, sizeof(h));
212 ndr->offset += sizeof(h);
220 NTSTATUS ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
223 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
224 *status = NT_STATUS(v);
231 NTSTATUS ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
233 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
236 void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
238 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
244 NTSTATUS ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
247 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
248 *status = W_ERROR(v);
255 NTSTATUS ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
257 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
260 void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
262 ndr->print(ndr, "%-25s: %d", name, W_ERROR_V(r));
268 NTSTATUS ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
270 NDR_PULL_NEED_BYTES(ndr, n);
271 memcpy(data, ndr->data + ndr->offset, n);
277 pull an array of uint8
279 NTSTATUS ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
281 if (!(ndr_flags & NDR_SCALARS)) {
284 return ndr_pull_bytes(ndr, data, n);
290 NTSTATUS ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
292 NDR_PUSH_NEED_BYTES(ndr, 1);
293 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
301 NTSTATUS ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
303 NDR_PUSH_NEED_BYTES(ndr, 1);
304 SCVAL(ndr->data, ndr->offset, v);
312 NTSTATUS ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
314 NDR_PUSH_ALIGN(ndr, 2);
315 NDR_PUSH_NEED_BYTES(ndr, 2);
316 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
324 NTSTATUS ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
326 NDR_PUSH_ALIGN(ndr, 2);
327 NDR_PUSH_NEED_BYTES(ndr, 2);
328 NDR_SSVAL(ndr, ndr->offset, v);
336 NTSTATUS ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
338 NDR_PUSH_ALIGN(ndr, 4);
339 NDR_PUSH_NEED_BYTES(ndr, 4);
340 NDR_SIVALS(ndr, ndr->offset, v);
348 NTSTATUS ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
350 NDR_PUSH_ALIGN(ndr, 4);
351 NDR_PUSH_NEED_BYTES(ndr, 4);
352 NDR_SIVAL(ndr, ndr->offset, v);
360 NTSTATUS ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
362 NDR_PUSH_ALIGN(ndr, 4);
363 NDR_PUSH_NEED_BYTES(ndr, 8);
364 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
365 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
373 NTSTATUS ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
375 NDR_PUSH_ALIGN(ndr, 4);
376 NDR_PUSH_NEED_BYTES(ndr, 8);
377 NDR_SIVAL(ndr, ndr->offset, (v>>32));
378 NDR_SIVAL(ndr, ndr->offset+4, (v & 0xFFFFFFFF));
386 NTSTATUS ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
388 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
394 NTSTATUS ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
396 NDR_PUSH_ALIGN(ndr, 8);
397 return ndr_push_udlong(ndr, NDR_SCALARS, v);
403 NTSTATUS ndr_push_pointer(struct ndr_push *ndr, int ndr_flags, void* v)
405 intptr_t h = (intptr_t)v;
406 NDR_PUSH_ALIGN(ndr, sizeof(h));
407 NDR_PUSH_NEED_BYTES(ndr, sizeof(h));
408 memcpy(ndr->data+ndr->offset, &h, sizeof(h));
409 ndr->offset += sizeof(h);
413 NTSTATUS ndr_push_align(struct ndr_push *ndr, size_t size)
415 NDR_PUSH_ALIGN(ndr, size);
419 NTSTATUS ndr_pull_align(struct ndr_pull *ndr, size_t size)
421 NDR_PULL_ALIGN(ndr, size);
428 NTSTATUS ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
430 NDR_PUSH_NEED_BYTES(ndr, n);
431 memcpy(ndr->data + ndr->offset, data, n);
439 NTSTATUS ndr_push_zero(struct ndr_push *ndr, uint32_t n)
441 NDR_PUSH_NEED_BYTES(ndr, n);
442 memset(ndr->data + ndr->offset, 0, n);
448 push an array of uint8
450 NTSTATUS ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
452 if (!(ndr_flags & NDR_SCALARS)) {
455 return ndr_push_bytes(ndr, data, n);
459 save the current position
461 void ndr_push_save(struct ndr_push *ndr, struct ndr_push_save *save)
463 save->offset = ndr->offset;
469 void ndr_push_restore(struct ndr_push *ndr, struct ndr_push_save *save)
471 ndr->offset = save->offset;
475 push a unique non-zero value if a pointer is non-NULL, otherwise 0
477 NTSTATUS ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
481 ptr = ndr->ptr_count * 4;
485 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
489 push a 'simple' full non-zero value if a pointer is non-NULL, otherwise 0
491 NTSTATUS ndr_push_sptr_ptr(struct ndr_push *ndr, const void *p)
496 ptr = ndr->ptr_count;
498 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
502 push always a 0, if a pointer is NULL it's a fatal error
504 NTSTATUS ndr_push_ref_ptr(struct ndr_push *ndr, const void *p)
507 return NT_STATUS_INVALID_PARAMETER_MIX;
509 return ndr_push_uint32(ndr, NDR_SCALARS, 0xAEF1AEF1);
515 NTSTATUS ndr_push_NTTIME(struct ndr_push *ndr, int ndr_flags, NTTIME t)
517 union NTTIME_big b; b.s3 = t;
518 NDR_CHECK(ndr_push_udlong(ndr, ndr_flags, b.s4));
525 NTSTATUS ndr_pull_NTTIME(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
528 NDR_CHECK(ndr_pull_udlong(ndr, ndr_flags, &b.s4));
537 NTSTATUS ndr_push_NTTIME_1sec(struct ndr_push *ndr, int ndr_flags, NTTIME t)
539 union NTTIME_big b; b.s3 = t;
542 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, b.s4));
549 NTSTATUS ndr_pull_NTTIME_1sec(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
552 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, &b.s4));
561 NTSTATUS ndr_pull_NTTIME_hyper(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
564 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, &b.s4));
572 NTSTATUS ndr_push_NTTIME_hyper(struct ndr_push *ndr, int ndr_flags, NTTIME t)
574 union NTTIME_big b; b.s3 = t;
575 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, b.s4));
582 NTSTATUS ndr_push_time_t(struct ndr_push *ndr, int ndr_flags, time_t t)
584 return ndr_push_uint32(ndr, ndr_flags, t);
590 NTSTATUS ndr_pull_time_t(struct ndr_pull *ndr, int ndr_flags, time_t *t)
593 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &tt));
599 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
601 ndr->print(ndr, "%s: struct %s", name, type);
604 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
605 const char *val, uint32_t value)
607 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
608 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
610 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
614 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value)
616 /* this is an attempt to support multi-bit bitmap masks */
619 while (!(flag & 1)) {
624 ndr->print(ndr, " %d: %-25s", value, flag_name);
626 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
630 void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
632 ndr->print(ndr, "%-25s: %d", name, v);
635 void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
637 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
640 void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
642 ndr->print(ndr, "%-25s: %d", name, v);
645 void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
647 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
650 void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
652 ndr->print(ndr, "%-25s: %d", name, v);
655 void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
657 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
660 void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
662 ndr->print(ndr, "%-25s: 0x%016llx (%llu)", name, v, v);
665 void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
667 ndr_print_udlong(ndr, name, v);
670 void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
672 ndr->print(ndr, "%-25s: 0x%016llx (%lld)", name, v, v);
675 void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
677 ndr_print_dlong(ndr, name, v);
680 void ndr_print_pointer(struct ndr_print *ndr, const char *name, void *v)
682 ndr->print(ndr, "%-25s: %p", name, v);
685 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
688 ndr->print(ndr, "%-25s: *", name);
690 ndr->print(ndr, "%-25s: NULL", name);
694 void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
696 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
699 void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
701 /* this is a standard NTTIME here
702 * as it's already converted in the pull/push code
704 ndr_print_NTTIME(ndr, name, t);
707 void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
709 ndr_print_NTTIME(ndr, name, t);
712 void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
714 if (t == (time_t)-1 || t == 0) {
715 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
717 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
721 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
723 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
724 ndr->print(ndr, "%-25s: union %s(case 0x%X)", name, type, level);
726 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
730 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
732 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
735 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
736 const uint8_t *data, uint32_t count)
740 if (count <= 600 && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
742 for (i=0;i<count;i++) {
743 snprintf(&s[i*2], 3, "%02x", data[i]);
746 ndr->print(ndr, "%-25s: %s", name, s);
750 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
752 for (i=0;i<count;i++) {
754 asprintf(&idx, "[%d]", i);
756 ndr_print_uint8(ndr, idx, data[i]);
763 void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
765 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, r.length);
767 dump_data(10, (const char *)r.data, r.length);
773 push a DATA_BLOB onto the wire.
775 NTSTATUS ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
777 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
778 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
779 blob.length = NDR_ALIGN(ndr, 2);
780 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
781 blob.length = NDR_ALIGN(ndr, 4);
782 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
783 blob.length = NDR_ALIGN(ndr, 8);
785 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
786 data_blob_clear(&blob);
787 } else if (!(ndr->flags & LIBNDR_FLAG_REMAINING)) {
788 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, blob.length));
790 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
795 pull a DATA_BLOB from the wire.
797 NTSTATUS ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
801 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
802 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
803 length = NDR_ALIGN(ndr, 2);
804 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
805 length = NDR_ALIGN(ndr, 4);
806 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
807 length = NDR_ALIGN(ndr, 8);
809 if (ndr->data_size - ndr->offset < length) {
810 length = ndr->data_size - ndr->offset;
812 } else if (ndr->flags & LIBNDR_FLAG_REMAINING) {
813 length = ndr->data_size - ndr->offset;
815 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
817 NDR_PULL_NEED_BYTES(ndr, length);
818 *blob = data_blob_talloc(ndr->current_mem_ctx, ndr->data+ndr->offset, length);
819 ndr->offset += length;
823 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
825 return ret + data->length;