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)
132 status = ndr_pull_uint32(ndr, NDR_SCALARS, v);
133 if (NT_STATUS_IS_OK(status) && *v != 0) {
140 parse a ref pointer referent identifier
142 NTSTATUS ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
144 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
145 /* ref pointers always point to data */
153 NTSTATUS ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
155 NDR_PULL_ALIGN(ndr, 4);
156 NDR_PULL_NEED_BYTES(ndr, 8);
157 *v = NDR_IVAL(ndr, ndr->offset);
158 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
166 NTSTATUS ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
168 NDR_PULL_ALIGN(ndr, 4);
169 NDR_PULL_NEED_BYTES(ndr, 8);
170 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
171 *v |= NDR_IVAL(ndr, ndr->offset+4);
179 NTSTATUS ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
181 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
187 NTSTATUS ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
189 NDR_PULL_ALIGN(ndr, 8);
190 return ndr_pull_udlong(ndr, ndr_flags, v);
196 NTSTATUS ndr_pull_pointer(struct ndr_pull *ndr, int ndr_flags, void* *v)
199 NDR_PULL_ALIGN(ndr, sizeof(h));
200 NDR_PULL_NEED_BYTES(ndr, sizeof(h));
201 memcpy(&h, ndr->data+ndr->offset, sizeof(h));
202 ndr->offset += sizeof(h);
210 NTSTATUS ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
213 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
214 *status = NT_STATUS(v);
221 NTSTATUS ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
223 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
226 void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
228 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
234 NTSTATUS ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
237 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
238 *status = W_ERROR(v);
245 NTSTATUS ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
247 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
250 void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
252 ndr->print(ndr, "%-25s: %s", name, dos_errstr(r));
258 NTSTATUS ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
260 NDR_PULL_NEED_BYTES(ndr, n);
261 memcpy(data, ndr->data + ndr->offset, n);
267 pull an array of uint8
269 NTSTATUS ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
271 if (!(ndr_flags & NDR_SCALARS)) {
274 return ndr_pull_bytes(ndr, data, n);
280 NTSTATUS ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
282 NDR_PUSH_NEED_BYTES(ndr, 1);
283 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
291 NTSTATUS ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
293 NDR_PUSH_NEED_BYTES(ndr, 1);
294 SCVAL(ndr->data, ndr->offset, v);
302 NTSTATUS ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
304 NDR_PUSH_ALIGN(ndr, 2);
305 NDR_PUSH_NEED_BYTES(ndr, 2);
306 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
314 NTSTATUS ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
316 NDR_PUSH_ALIGN(ndr, 2);
317 NDR_PUSH_NEED_BYTES(ndr, 2);
318 NDR_SSVAL(ndr, ndr->offset, v);
326 NTSTATUS ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
328 NDR_PUSH_ALIGN(ndr, 4);
329 NDR_PUSH_NEED_BYTES(ndr, 4);
330 NDR_SIVALS(ndr, ndr->offset, v);
338 NTSTATUS ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
340 NDR_PUSH_ALIGN(ndr, 4);
341 NDR_PUSH_NEED_BYTES(ndr, 4);
342 NDR_SIVAL(ndr, ndr->offset, v);
350 NTSTATUS ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
352 NDR_PUSH_ALIGN(ndr, 4);
353 NDR_PUSH_NEED_BYTES(ndr, 8);
354 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
355 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
363 NTSTATUS ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
365 NDR_PUSH_ALIGN(ndr, 4);
366 NDR_PUSH_NEED_BYTES(ndr, 8);
367 NDR_SIVAL(ndr, ndr->offset, (v>>32));
368 NDR_SIVAL(ndr, ndr->offset+4, (v & 0xFFFFFFFF));
376 NTSTATUS ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
378 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
384 NTSTATUS ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
386 NDR_PUSH_ALIGN(ndr, 8);
387 return ndr_push_udlong(ndr, NDR_SCALARS, v);
393 NTSTATUS ndr_push_pointer(struct ndr_push *ndr, int ndr_flags, void* v)
395 intptr_t h = (intptr_t)v;
396 NDR_PUSH_ALIGN(ndr, sizeof(h));
397 NDR_PUSH_NEED_BYTES(ndr, sizeof(h));
398 memcpy(ndr->data+ndr->offset, &h, sizeof(h));
399 ndr->offset += sizeof(h);
403 NTSTATUS ndr_push_align(struct ndr_push *ndr, size_t size)
405 NDR_PUSH_ALIGN(ndr, size);
409 NTSTATUS ndr_pull_align(struct ndr_pull *ndr, size_t size)
411 NDR_PULL_ALIGN(ndr, size);
418 NTSTATUS ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
420 NDR_PUSH_NEED_BYTES(ndr, n);
421 memcpy(ndr->data + ndr->offset, data, n);
429 NTSTATUS ndr_push_zero(struct ndr_push *ndr, uint32_t n)
431 NDR_PUSH_NEED_BYTES(ndr, n);
432 memset(ndr->data + ndr->offset, 0, n);
438 push an array of uint8
440 NTSTATUS ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
442 if (!(ndr_flags & NDR_SCALARS)) {
445 return ndr_push_bytes(ndr, data, n);
449 save the current position
451 void ndr_push_save(struct ndr_push *ndr, struct ndr_push_save *save)
453 save->offset = ndr->offset;
459 void ndr_push_restore(struct ndr_push *ndr, struct ndr_push_save *save)
461 ndr->offset = save->offset;
465 push a unique non-zero value if a pointer is non-NULL, otherwise 0
467 NTSTATUS ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
471 ptr = ndr->ptr_count * 4;
475 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
479 push a 'simple' full non-zero value if a pointer is non-NULL, otherwise 0
481 NTSTATUS ndr_push_full_ptr(struct ndr_push *ndr, const void *p)
485 /* Check if the pointer already exists and has an id */
486 ptr = ndr_token_peek(&ndr->full_ptr_list, p);
489 ptr = ndr->ptr_count;
490 ndr_token_store(ndr, &ndr->full_ptr_list, p, ptr);
493 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
497 push always a 0, if a pointer is NULL it's a fatal error
499 NTSTATUS ndr_push_ref_ptr(struct ndr_push *ndr)
501 return ndr_push_uint32(ndr, NDR_SCALARS, 0xAEF1AEF1);
507 NTSTATUS ndr_push_NTTIME(struct ndr_push *ndr, int ndr_flags, NTTIME t)
509 NDR_CHECK(ndr_push_udlong(ndr, ndr_flags, t));
516 NTSTATUS ndr_pull_NTTIME(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
518 NDR_CHECK(ndr_pull_udlong(ndr, ndr_flags, t));
525 NTSTATUS ndr_push_NTTIME_1sec(struct ndr_push *ndr, int ndr_flags, NTTIME t)
528 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
535 NTSTATUS ndr_pull_NTTIME_1sec(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
537 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
545 NTSTATUS ndr_pull_NTTIME_hyper(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
547 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
554 NTSTATUS ndr_push_NTTIME_hyper(struct ndr_push *ndr, int ndr_flags, NTTIME t)
556 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
563 NTSTATUS ndr_push_time_t(struct ndr_push *ndr, int ndr_flags, time_t t)
565 return ndr_push_uint32(ndr, ndr_flags, t);
571 NTSTATUS ndr_pull_time_t(struct ndr_pull *ndr, int ndr_flags, time_t *t)
574 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &tt));
582 NTSTATUS ndr_pull_ipv4address(struct ndr_pull *ndr, int ndr_flags, const char **address)
585 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &in.s_addr));
586 in.s_addr = htonl(in.s_addr);
587 *address = talloc_strdup(ndr->current_mem_ctx, inet_ntoa(in));
588 NT_STATUS_HAVE_NO_MEMORY(*address);
595 NTSTATUS ndr_push_ipv4address(struct ndr_push *ndr, int ndr_flags, const char *address)
598 if (!is_ipaddress_v4(address)) {
599 return ndr_push_error(ndr, NDR_ERR_IPV4ADDRESS,
600 "Invalid IPv4 address: '%s'",
603 addr = inet_addr(address);
604 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, htonl(addr)));
611 void ndr_print_ipv4address(struct ndr_print *ndr, const char *name,
614 ndr->print(ndr, "%-25s: %s", name, address);
617 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
619 ndr->print(ndr, "%s: struct %s", name, type);
622 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
623 const char *val, uint32_t value)
625 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
626 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
628 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
632 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value)
634 /* this is an attempt to support multi-bit bitmap masks */
637 while (!(flag & 1)) {
642 ndr->print(ndr, " %d: %-25s", value, flag_name);
644 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
648 void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
650 ndr->print(ndr, "%-25s: %d", name, v);
653 void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
655 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
658 void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
660 ndr->print(ndr, "%-25s: %d", name, v);
663 void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
665 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
668 void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
670 ndr->print(ndr, "%-25s: %d", name, v);
673 void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
675 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
678 void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
680 ndr->print(ndr, "%-25s: 0x%016llx (%llu)", name, v, v);
683 void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
685 ndr_print_udlong(ndr, name, v);
688 void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
690 ndr->print(ndr, "%-25s: 0x%016llx (%lld)", name, v, v);
693 void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
695 ndr_print_dlong(ndr, name, v);
698 void ndr_print_pointer(struct ndr_print *ndr, const char *name, void *v)
700 ndr->print(ndr, "%-25s: %p", name, v);
703 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
706 ndr->print(ndr, "%-25s: *", name);
708 ndr->print(ndr, "%-25s: NULL", name);
712 void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
714 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
717 void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
719 /* this is a standard NTTIME here
720 * as it's already converted in the pull/push code
722 ndr_print_NTTIME(ndr, name, t);
725 void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
727 ndr_print_NTTIME(ndr, name, t);
730 void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
732 if (t == (time_t)-1 || t == 0) {
733 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
735 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
739 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
741 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
742 ndr->print(ndr, "%-25s: union %s(case 0x%X)", name, type, level);
744 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
748 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
750 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
753 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
754 const uint8_t *data, uint32_t count)
758 if (count <= 600 && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
760 for (i=0;i<count;i++) {
761 snprintf(&s[i*2], 3, "%02x", data[i]);
764 ndr->print(ndr, "%-25s: %s", name, s);
768 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
770 for (i=0;i<count;i++) {
772 asprintf(&idx, "[%d]", i);
774 ndr_print_uint8(ndr, idx, data[i]);
781 void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
783 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, r.length);
785 dump_data(10, r.data, r.length);
791 push a DATA_BLOB onto the wire.
793 NTSTATUS ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
795 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
796 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
797 blob.length = NDR_ALIGN(ndr, 2);
798 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
799 blob.length = NDR_ALIGN(ndr, 4);
800 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
801 blob.length = NDR_ALIGN(ndr, 8);
803 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
804 data_blob_clear(&blob);
805 } else if (!(ndr->flags & LIBNDR_FLAG_REMAINING)) {
806 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, blob.length));
808 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
813 pull a DATA_BLOB from the wire.
815 NTSTATUS ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
819 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
820 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
821 length = NDR_ALIGN(ndr, 2);
822 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
823 length = NDR_ALIGN(ndr, 4);
824 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
825 length = NDR_ALIGN(ndr, 8);
827 if (ndr->data_size - ndr->offset < length) {
828 length = ndr->data_size - ndr->offset;
830 } else if (ndr->flags & LIBNDR_FLAG_REMAINING) {
831 length = ndr->data_size - ndr->offset;
833 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
835 NDR_PULL_NEED_BYTES(ndr, length);
836 *blob = data_blob_talloc(ndr->current_mem_ctx, ndr->data+ndr->offset, length);
837 ndr->offset += length;
841 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
843 if (!data) return ret;
844 return ret + data->length;