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 3 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, see <http://www.gnu.org/licenses/>.
24 #define NDR_SVAL(ndr, ofs) (NDR_BE(ndr)?RSVAL(ndr->data,ofs):SVAL(ndr->data,ofs))
25 #define NDR_IVAL(ndr, ofs) (NDR_BE(ndr)?RIVAL(ndr->data,ofs):IVAL(ndr->data,ofs))
26 #define NDR_IVALS(ndr, ofs) (NDR_BE(ndr)?RIVALS(ndr->data,ofs):IVALS(ndr->data,ofs))
27 #define NDR_SSVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSSVAL(ndr->data,ofs,v); } else SSVAL(ndr->data,ofs,v); } while (0)
28 #define NDR_SIVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVAL(ndr->data,ofs,v); } else SIVAL(ndr->data,ofs,v); } while (0)
29 #define NDR_SIVALS(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVALS(ndr->data,ofs,v); } else SIVALS(ndr->data,ofs,v); } while (0)
33 check for data leaks from the server by looking for non-zero pad bytes
34 these could also indicate that real structure elements have been
35 mistaken for padding in the IDL
37 void ndr_check_padding(struct ndr_pull *ndr, size_t n)
39 size_t ofs2 = (ndr->offset + (n-1)) & ~(n-1);
41 for (i=ndr->offset;i<ofs2;i++) {
42 if (ndr->data[i] != 0) {
47 DEBUG(0,("WARNING: Non-zero padding to %d: ", (int)n));
48 for (i=ndr->offset;i<ofs2;i++) {
49 DEBUG(0,("%02x ", ndr->data[i]));
59 NTSTATUS ndr_pull_int8(struct ndr_pull *ndr, int ndr_flags, int8_t *v)
61 NDR_PULL_NEED_BYTES(ndr, 1);
62 *v = (int8_t)CVAL(ndr->data, ndr->offset);
70 NTSTATUS ndr_pull_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
72 NDR_PULL_NEED_BYTES(ndr, 1);
73 *v = CVAL(ndr->data, ndr->offset);
81 NTSTATUS ndr_pull_int16(struct ndr_pull *ndr, int ndr_flags, int16_t *v)
83 NDR_PULL_ALIGN(ndr, 2);
84 NDR_PULL_NEED_BYTES(ndr, 2);
85 *v = (uint16_t)NDR_SVAL(ndr, ndr->offset);
93 NTSTATUS ndr_pull_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
95 NDR_PULL_ALIGN(ndr, 2);
96 NDR_PULL_NEED_BYTES(ndr, 2);
97 *v = NDR_SVAL(ndr, ndr->offset);
105 NTSTATUS ndr_pull_int32(struct ndr_pull *ndr, int ndr_flags, int32_t *v)
107 NDR_PULL_ALIGN(ndr, 4);
108 NDR_PULL_NEED_BYTES(ndr, 4);
109 *v = NDR_IVALS(ndr, ndr->offset);
117 NTSTATUS ndr_pull_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
119 NDR_PULL_ALIGN(ndr, 4);
120 NDR_PULL_NEED_BYTES(ndr, 4);
121 *v = NDR_IVAL(ndr, ndr->offset);
127 parse a pointer referent identifier
129 NTSTATUS ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v)
131 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
139 parse a ref pointer referent identifier
141 NTSTATUS ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
143 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
144 /* ref pointers always point to data */
152 NTSTATUS ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
154 NDR_PULL_ALIGN(ndr, 4);
155 NDR_PULL_NEED_BYTES(ndr, 8);
156 *v = NDR_IVAL(ndr, ndr->offset);
157 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
165 NTSTATUS ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
167 NDR_PULL_ALIGN(ndr, 4);
168 NDR_PULL_NEED_BYTES(ndr, 8);
169 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
170 *v |= NDR_IVAL(ndr, ndr->offset+4);
178 NTSTATUS ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
180 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
186 NTSTATUS ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
188 NDR_PULL_ALIGN(ndr, 8);
189 return ndr_pull_udlong(ndr, ndr_flags, v);
195 NTSTATUS ndr_pull_pointer(struct ndr_pull *ndr, int ndr_flags, void* *v)
198 NDR_PULL_ALIGN(ndr, sizeof(h));
199 NDR_PULL_NEED_BYTES(ndr, sizeof(h));
200 memcpy(&h, ndr->data+ndr->offset, sizeof(h));
201 ndr->offset += sizeof(h);
209 NTSTATUS ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
212 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
213 *status = NT_STATUS(v);
220 NTSTATUS ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
222 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
225 void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
227 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
233 NTSTATUS ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
236 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
237 *status = W_ERROR(v);
244 NTSTATUS ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
246 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
249 void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
251 ndr->print(ndr, "%-25s: %s", name, dos_errstr(r));
257 NTSTATUS ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
259 NDR_PULL_NEED_BYTES(ndr, n);
260 memcpy(data, ndr->data + ndr->offset, n);
266 pull an array of uint8
268 NTSTATUS ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
270 if (!(ndr_flags & NDR_SCALARS)) {
273 return ndr_pull_bytes(ndr, data, n);
279 NTSTATUS ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
281 NDR_PUSH_NEED_BYTES(ndr, 1);
282 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
290 NTSTATUS ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
292 NDR_PUSH_NEED_BYTES(ndr, 1);
293 SCVAL(ndr->data, ndr->offset, v);
301 NTSTATUS ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
303 NDR_PUSH_ALIGN(ndr, 2);
304 NDR_PUSH_NEED_BYTES(ndr, 2);
305 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
313 NTSTATUS ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
315 NDR_PUSH_ALIGN(ndr, 2);
316 NDR_PUSH_NEED_BYTES(ndr, 2);
317 NDR_SSVAL(ndr, ndr->offset, v);
325 NTSTATUS ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
327 NDR_PUSH_ALIGN(ndr, 4);
328 NDR_PUSH_NEED_BYTES(ndr, 4);
329 NDR_SIVALS(ndr, ndr->offset, v);
337 NTSTATUS ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
339 NDR_PUSH_ALIGN(ndr, 4);
340 NDR_PUSH_NEED_BYTES(ndr, 4);
341 NDR_SIVAL(ndr, ndr->offset, v);
349 NTSTATUS ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
351 NDR_PUSH_ALIGN(ndr, 4);
352 NDR_PUSH_NEED_BYTES(ndr, 8);
353 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
354 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
362 NTSTATUS ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
364 NDR_PUSH_ALIGN(ndr, 4);
365 NDR_PUSH_NEED_BYTES(ndr, 8);
366 NDR_SIVAL(ndr, ndr->offset, (v>>32));
367 NDR_SIVAL(ndr, ndr->offset+4, (v & 0xFFFFFFFF));
375 NTSTATUS ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
377 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
383 NTSTATUS ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
385 NDR_PUSH_ALIGN(ndr, 8);
386 return ndr_push_udlong(ndr, NDR_SCALARS, v);
392 NTSTATUS ndr_push_pointer(struct ndr_push *ndr, int ndr_flags, void* v)
394 intptr_t h = (intptr_t)v;
395 NDR_PUSH_ALIGN(ndr, sizeof(h));
396 NDR_PUSH_NEED_BYTES(ndr, sizeof(h));
397 memcpy(ndr->data+ndr->offset, &h, sizeof(h));
398 ndr->offset += sizeof(h);
402 NTSTATUS ndr_push_align(struct ndr_push *ndr, size_t size)
404 NDR_PUSH_ALIGN(ndr, size);
408 NTSTATUS ndr_pull_align(struct ndr_pull *ndr, size_t size)
410 NDR_PULL_ALIGN(ndr, size);
417 NTSTATUS ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
419 NDR_PUSH_NEED_BYTES(ndr, n);
420 memcpy(ndr->data + ndr->offset, data, n);
428 NTSTATUS ndr_push_zero(struct ndr_push *ndr, uint32_t n)
430 NDR_PUSH_NEED_BYTES(ndr, n);
431 memset(ndr->data + ndr->offset, 0, n);
437 push an array of uint8
439 NTSTATUS ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
441 if (!(ndr_flags & NDR_SCALARS)) {
444 return ndr_push_bytes(ndr, data, n);
448 save the current position
450 void ndr_push_save(struct ndr_push *ndr, struct ndr_push_save *save)
452 save->offset = ndr->offset;
458 void ndr_push_restore(struct ndr_push *ndr, struct ndr_push_save *save)
460 ndr->offset = save->offset;
464 push a unique non-zero value if a pointer is non-NULL, otherwise 0
466 NTSTATUS ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
470 ptr = ndr->ptr_count * 4;
474 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
478 push a 'simple' full non-zero value if a pointer is non-NULL, otherwise 0
480 NTSTATUS ndr_push_full_ptr(struct ndr_push *ndr, const void *p)
484 /* Check if the pointer already exists and has an id */
485 ptr = ndr_token_peek(&ndr->full_ptr_list, p);
488 ptr = ndr->ptr_count;
489 ndr_token_store(ndr, &ndr->full_ptr_list, p, ptr);
492 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
496 push always a 0, if a pointer is NULL it's a fatal error
498 NTSTATUS ndr_push_ref_ptr(struct ndr_push *ndr)
500 return ndr_push_uint32(ndr, NDR_SCALARS, 0xAEF1AEF1);
506 NTSTATUS ndr_push_NTTIME(struct ndr_push *ndr, int ndr_flags, NTTIME t)
508 NDR_CHECK(ndr_push_udlong(ndr, ndr_flags, t));
515 NTSTATUS ndr_pull_NTTIME(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
517 NDR_CHECK(ndr_pull_udlong(ndr, ndr_flags, t));
524 NTSTATUS ndr_push_NTTIME_1sec(struct ndr_push *ndr, int ndr_flags, NTTIME t)
527 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
534 NTSTATUS ndr_pull_NTTIME_1sec(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
536 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
544 NTSTATUS ndr_pull_NTTIME_hyper(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
546 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
553 NTSTATUS ndr_push_NTTIME_hyper(struct ndr_push *ndr, int ndr_flags, NTTIME t)
555 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
562 NTSTATUS ndr_push_time_t(struct ndr_push *ndr, int ndr_flags, time_t t)
564 return ndr_push_uint32(ndr, ndr_flags, t);
570 NTSTATUS ndr_pull_time_t(struct ndr_pull *ndr, int ndr_flags, time_t *t)
573 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &tt));
581 NTSTATUS ndr_pull_ipv4address(struct ndr_pull *ndr, int ndr_flags, const char **address)
584 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &in.s_addr));
585 in.s_addr = htonl(in.s_addr);
586 *address = talloc_strdup(ndr->current_mem_ctx, inet_ntoa(in));
587 NT_STATUS_HAVE_NO_MEMORY(*address);
594 NTSTATUS ndr_push_ipv4address(struct ndr_push *ndr, int ndr_flags, const char *address)
597 if (!is_ipaddress_v4(address)) {
598 return ndr_push_error(ndr, NDR_ERR_IPV4ADDRESS,
599 "Invalid IPv4 address: '%s'",
602 addr = inet_addr(address);
603 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, htonl(addr)));
610 void ndr_print_ipv4address(struct ndr_print *ndr, const char *name,
613 ndr->print(ndr, "%-25s: %s", name, address);
616 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
618 ndr->print(ndr, "%s: struct %s", name, type);
621 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
622 const char *val, uint32_t value)
624 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
625 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
627 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
631 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value)
633 /* this is an attempt to support multi-bit bitmap masks */
636 while (!(flag & 1)) {
641 ndr->print(ndr, " %d: %-25s", value, flag_name);
643 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
647 void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
649 ndr->print(ndr, "%-25s: %d", name, v);
652 void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
654 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
657 void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
659 ndr->print(ndr, "%-25s: %d", name, v);
662 void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
664 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
667 void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
669 ndr->print(ndr, "%-25s: %d", name, v);
672 void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
674 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
677 void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
679 ndr->print(ndr, "%-25s: 0x%016llx (%llu)", name, v, v);
682 void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
684 ndr_print_udlong(ndr, name, v);
687 void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
689 ndr->print(ndr, "%-25s: 0x%016llx (%lld)", name, v, v);
692 void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
694 ndr_print_dlong(ndr, name, v);
697 void ndr_print_pointer(struct ndr_print *ndr, const char *name, void *v)
699 ndr->print(ndr, "%-25s: %p", name, v);
702 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
705 ndr->print(ndr, "%-25s: *", name);
707 ndr->print(ndr, "%-25s: NULL", name);
711 void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
713 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
716 void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
718 /* this is a standard NTTIME here
719 * as it's already converted in the pull/push code
721 ndr_print_NTTIME(ndr, name, t);
724 void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
726 ndr_print_NTTIME(ndr, name, t);
729 void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
731 if (t == (time_t)-1 || t == 0) {
732 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
734 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
738 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
740 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
741 ndr->print(ndr, "%-25s: union %s(case 0x%X)", name, type, level);
743 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
747 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
749 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
752 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
753 const uint8_t *data, uint32_t count)
757 if (count <= 600 && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
759 for (i=0;i<count;i++) {
760 snprintf(&s[i*2], 3, "%02x", data[i]);
763 ndr->print(ndr, "%-25s: %s", name, s);
767 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
769 for (i=0;i<count;i++) {
771 asprintf(&idx, "[%d]", i);
773 ndr_print_uint8(ndr, idx, data[i]);
780 void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
782 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, r.length);
784 dump_data(10, r.data, r.length);
790 push a DATA_BLOB onto the wire.
792 NTSTATUS ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
794 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
795 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
796 blob.length = NDR_ALIGN(ndr, 2);
797 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
798 blob.length = NDR_ALIGN(ndr, 4);
799 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
800 blob.length = NDR_ALIGN(ndr, 8);
802 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
803 data_blob_clear(&blob);
804 } else if (!(ndr->flags & LIBNDR_FLAG_REMAINING)) {
805 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, blob.length));
807 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
812 pull a DATA_BLOB from the wire.
814 NTSTATUS ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
818 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
819 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
820 length = NDR_ALIGN(ndr, 2);
821 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
822 length = NDR_ALIGN(ndr, 4);
823 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
824 length = NDR_ALIGN(ndr, 8);
826 if (ndr->data_size - ndr->offset < length) {
827 length = ndr->data_size - ndr->offset;
829 } else if (ndr->flags & LIBNDR_FLAG_REMAINING) {
830 length = ndr->data_size - ndr->offset;
832 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
834 NDR_PULL_NEED_BYTES(ndr, length);
835 *blob = data_blob_talloc(ndr->current_mem_ctx, ndr->data+ndr->offset, length);
836 ndr->offset += length;
840 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
842 if (!data) return ret;
843 return ret + data->length;