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, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #define NDR_SVAL(ndr, ofs) (NDR_BE(ndr)?RSVAL(ndr->data,ofs):SVAL(ndr->data,ofs))
26 #define NDR_IVAL(ndr, ofs) (NDR_BE(ndr)?RIVAL(ndr->data,ofs):IVAL(ndr->data,ofs))
27 #define NDR_IVALS(ndr, ofs) (NDR_BE(ndr)?RIVALS(ndr->data,ofs):IVALS(ndr->data,ofs))
28 #define NDR_SSVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSSVAL(ndr->data,ofs,v); } else SSVAL(ndr->data,ofs,v); } while (0)
29 #define NDR_SIVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVAL(ndr->data,ofs,v); } else SIVAL(ndr->data,ofs,v); } while (0)
30 #define NDR_SIVALS(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVALS(ndr->data,ofs,v); } else SIVALS(ndr->data,ofs,v); } while (0)
34 check for data leaks from the server by looking for non-zero pad bytes
35 these could also indicate that real structure elements have been
36 mistaken for padding in the IDL
38 void ndr_check_padding(struct ndr_pull *ndr, size_t n)
40 size_t ofs2 = (ndr->offset + (n-1)) & ~(n-1);
42 for (i=ndr->offset;i<ofs2;i++) {
43 if (ndr->data[i] != 0) {
48 DEBUG(0,("WARNING: Non-zero padding to %d: ", (int)n));
49 for (i=ndr->offset;i<ofs2;i++) {
50 DEBUG(0,("%02x ", ndr->data[i]));
60 NTSTATUS ndr_pull_int8(struct ndr_pull *ndr, int ndr_flags, int8_t *v)
62 NDR_PULL_NEED_BYTES(ndr, 1);
63 *v = (int8_t)CVAL(ndr->data, ndr->offset);
71 NTSTATUS ndr_pull_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
73 NDR_PULL_NEED_BYTES(ndr, 1);
74 *v = CVAL(ndr->data, ndr->offset);
82 NTSTATUS ndr_pull_int16(struct ndr_pull *ndr, int ndr_flags, int16_t *v)
84 NDR_PULL_ALIGN(ndr, 2);
85 NDR_PULL_NEED_BYTES(ndr, 2);
86 *v = (uint16_t)NDR_SVAL(ndr, ndr->offset);
94 NTSTATUS ndr_pull_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
96 NDR_PULL_ALIGN(ndr, 2);
97 NDR_PULL_NEED_BYTES(ndr, 2);
98 *v = NDR_SVAL(ndr, ndr->offset);
106 NTSTATUS ndr_pull_int32(struct ndr_pull *ndr, int ndr_flags, int32_t *v)
108 NDR_PULL_ALIGN(ndr, 4);
109 NDR_PULL_NEED_BYTES(ndr, 4);
110 *v = NDR_IVALS(ndr, ndr->offset);
118 NTSTATUS ndr_pull_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
120 NDR_PULL_ALIGN(ndr, 4);
121 NDR_PULL_NEED_BYTES(ndr, 4);
122 *v = NDR_IVAL(ndr, ndr->offset);
128 parse a pointer referent identifier
130 NTSTATUS ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v)
133 status = ndr_pull_uint32(ndr, NDR_SCALARS, v);
134 if (NT_STATUS_IS_OK(status) && *v != 0) {
141 parse a ref pointer referent identifier
143 NTSTATUS ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
145 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
146 /* ref pointers always point to data */
154 NTSTATUS ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
156 NDR_PULL_ALIGN(ndr, 4);
157 NDR_PULL_NEED_BYTES(ndr, 8);
158 *v = NDR_IVAL(ndr, ndr->offset);
159 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
167 NTSTATUS ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
169 NDR_PULL_ALIGN(ndr, 4);
170 NDR_PULL_NEED_BYTES(ndr, 8);
171 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
172 *v |= NDR_IVAL(ndr, ndr->offset+4);
180 NTSTATUS ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
182 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
188 NTSTATUS ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
190 NDR_PULL_ALIGN(ndr, 8);
191 return ndr_pull_udlong(ndr, ndr_flags, v);
197 NTSTATUS ndr_pull_pointer(struct ndr_pull *ndr, int ndr_flags, void* *v)
200 NDR_PULL_ALIGN(ndr, sizeof(h));
201 NDR_PULL_NEED_BYTES(ndr, sizeof(h));
202 memcpy(&h, ndr->data+ndr->offset, sizeof(h));
203 ndr->offset += sizeof(h);
211 NTSTATUS ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
214 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
215 *status = NT_STATUS(v);
222 NTSTATUS ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
224 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
227 void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
229 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
235 NTSTATUS ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
238 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
239 *status = W_ERROR(v);
246 NTSTATUS ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
248 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
251 void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
253 ndr->print(ndr, "%-25s: %s", name, dos_errstr(r));
259 NTSTATUS ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
261 NDR_PULL_NEED_BYTES(ndr, n);
262 memcpy(data, ndr->data + ndr->offset, n);
268 pull an array of uint8
270 NTSTATUS ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
272 if (!(ndr_flags & NDR_SCALARS)) {
275 return ndr_pull_bytes(ndr, data, n);
281 NTSTATUS ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
283 NDR_PUSH_NEED_BYTES(ndr, 1);
284 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
292 NTSTATUS ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
294 NDR_PUSH_NEED_BYTES(ndr, 1);
295 SCVAL(ndr->data, ndr->offset, v);
303 NTSTATUS ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
305 NDR_PUSH_ALIGN(ndr, 2);
306 NDR_PUSH_NEED_BYTES(ndr, 2);
307 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
315 NTSTATUS ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
317 NDR_PUSH_ALIGN(ndr, 2);
318 NDR_PUSH_NEED_BYTES(ndr, 2);
319 NDR_SSVAL(ndr, ndr->offset, v);
327 NTSTATUS ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
329 NDR_PUSH_ALIGN(ndr, 4);
330 NDR_PUSH_NEED_BYTES(ndr, 4);
331 NDR_SIVALS(ndr, ndr->offset, v);
339 NTSTATUS ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
341 NDR_PUSH_ALIGN(ndr, 4);
342 NDR_PUSH_NEED_BYTES(ndr, 4);
343 NDR_SIVAL(ndr, ndr->offset, v);
351 NTSTATUS ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
353 NDR_PUSH_ALIGN(ndr, 4);
354 NDR_PUSH_NEED_BYTES(ndr, 8);
355 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
356 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
364 NTSTATUS ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
366 NDR_PUSH_ALIGN(ndr, 4);
367 NDR_PUSH_NEED_BYTES(ndr, 8);
368 NDR_SIVAL(ndr, ndr->offset, (v>>32));
369 NDR_SIVAL(ndr, ndr->offset+4, (v & 0xFFFFFFFF));
377 NTSTATUS ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
379 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
385 NTSTATUS ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
387 NDR_PUSH_ALIGN(ndr, 8);
388 return ndr_push_udlong(ndr, NDR_SCALARS, v);
394 NTSTATUS ndr_push_pointer(struct ndr_push *ndr, int ndr_flags, void* v)
396 intptr_t h = (intptr_t)v;
397 NDR_PUSH_ALIGN(ndr, sizeof(h));
398 NDR_PUSH_NEED_BYTES(ndr, sizeof(h));
399 memcpy(ndr->data+ndr->offset, &h, sizeof(h));
400 ndr->offset += sizeof(h);
404 NTSTATUS ndr_push_align(struct ndr_push *ndr, size_t size)
406 NDR_PUSH_ALIGN(ndr, size);
410 NTSTATUS ndr_pull_align(struct ndr_pull *ndr, size_t size)
412 NDR_PULL_ALIGN(ndr, size);
419 NTSTATUS ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
421 NDR_PUSH_NEED_BYTES(ndr, n);
422 memcpy(ndr->data + ndr->offset, data, n);
430 NTSTATUS ndr_push_zero(struct ndr_push *ndr, uint32_t n)
432 NDR_PUSH_NEED_BYTES(ndr, n);
433 memset(ndr->data + ndr->offset, 0, n);
439 push an array of uint8
441 NTSTATUS ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
443 if (!(ndr_flags & NDR_SCALARS)) {
446 return ndr_push_bytes(ndr, data, n);
450 save the current position
452 void ndr_push_save(struct ndr_push *ndr, struct ndr_push_save *save)
454 save->offset = ndr->offset;
460 void ndr_push_restore(struct ndr_push *ndr, struct ndr_push_save *save)
462 ndr->offset = save->offset;
466 push a unique non-zero value if a pointer is non-NULL, otherwise 0
468 NTSTATUS ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
472 ptr = ndr->ptr_count * 4;
476 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
480 push a 'simple' full non-zero value if a pointer is non-NULL, otherwise 0
482 NTSTATUS ndr_push_full_ptr(struct ndr_push *ndr, const void *p)
486 /* Check if the pointer already exists and has an id */
487 ptr = ndr_token_peek(&ndr->full_ptr_list, p);
490 ptr = ndr->ptr_count;
491 ndr_token_store(ndr, &ndr->full_ptr_list, p, ptr);
494 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
498 push always a 0, if a pointer is NULL it's a fatal error
500 NTSTATUS ndr_push_ref_ptr(struct ndr_push *ndr)
502 return ndr_push_uint32(ndr, NDR_SCALARS, 0xAEF1AEF1);
508 NTSTATUS ndr_push_NTTIME(struct ndr_push *ndr, int ndr_flags, NTTIME t)
510 NDR_CHECK(ndr_push_udlong(ndr, ndr_flags, t));
517 NTSTATUS ndr_pull_NTTIME(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
519 NDR_CHECK(ndr_pull_udlong(ndr, ndr_flags, t));
526 NTSTATUS ndr_push_NTTIME_1sec(struct ndr_push *ndr, int ndr_flags, NTTIME t)
529 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
536 NTSTATUS ndr_pull_NTTIME_1sec(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
538 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
546 NTSTATUS ndr_pull_NTTIME_hyper(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
548 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
555 NTSTATUS ndr_push_NTTIME_hyper(struct ndr_push *ndr, int ndr_flags, NTTIME t)
557 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
564 NTSTATUS ndr_push_time_t(struct ndr_push *ndr, int ndr_flags, time_t t)
566 return ndr_push_uint32(ndr, ndr_flags, t);
572 NTSTATUS ndr_pull_time_t(struct ndr_pull *ndr, int ndr_flags, time_t *t)
575 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &tt));
583 NTSTATUS ndr_pull_ipv4address(struct ndr_pull *ndr, int ndr_flags, const char **address)
586 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &in.s_addr));
587 in.s_addr = htonl(in.s_addr);
588 *address = talloc_strdup(ndr->current_mem_ctx, inet_ntoa(in));
589 NT_STATUS_HAVE_NO_MEMORY(*address);
596 NTSTATUS ndr_push_ipv4address(struct ndr_push *ndr, int ndr_flags, const char *address)
599 if (!is_ipaddress(address)) {
600 return ndr_push_error(ndr, NDR_ERR_IPV4ADDRESS,
601 "Invalid IPv4 address: '%s'",
604 addr = inet_addr(address);
605 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, htonl(addr)));
612 void ndr_print_ipv4address(struct ndr_print *ndr, const char *name,
615 ndr->print(ndr, "%-25s: %s", name, address);
618 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
620 ndr->print(ndr, "%s: struct %s", name, type);
623 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
624 const char *val, uint32_t value)
626 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
627 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
629 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
633 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value)
635 /* this is an attempt to support multi-bit bitmap masks */
638 while (!(flag & 1)) {
643 ndr->print(ndr, " %d: %-25s", value, flag_name);
645 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
649 void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
651 ndr->print(ndr, "%-25s: %d", name, v);
654 void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
656 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
659 void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
661 ndr->print(ndr, "%-25s: %d", name, v);
664 void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
666 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
669 void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
671 ndr->print(ndr, "%-25s: %d", name, v);
674 void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
676 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
679 void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
681 ndr->print(ndr, "%-25s: 0x%016llx (%llu)", name, v, v);
684 void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
686 ndr_print_udlong(ndr, name, v);
689 void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
691 ndr->print(ndr, "%-25s: 0x%016llx (%lld)", name, v, v);
694 void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
696 ndr_print_dlong(ndr, name, v);
699 void ndr_print_pointer(struct ndr_print *ndr, const char *name, void *v)
701 ndr->print(ndr, "%-25s: %p", name, v);
704 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
707 ndr->print(ndr, "%-25s: *", name);
709 ndr->print(ndr, "%-25s: NULL", name);
713 void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
715 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
718 void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
720 /* this is a standard NTTIME here
721 * as it's already converted in the pull/push code
723 ndr_print_NTTIME(ndr, name, t);
726 void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
728 ndr_print_NTTIME(ndr, name, t);
731 void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
733 if (t == (time_t)-1 || t == 0) {
734 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
736 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
740 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
742 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
743 ndr->print(ndr, "%-25s: union %s(case 0x%X)", name, type, level);
745 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
749 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
751 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
754 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
755 const uint8_t *data, uint32_t count)
759 if (count <= 600 && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
761 for (i=0;i<count;i++) {
762 snprintf(&s[i*2], 3, "%02x", data[i]);
765 ndr->print(ndr, "%-25s: %s", name, s);
769 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
771 for (i=0;i<count;i++) {
773 asprintf(&idx, "[%d]", i);
775 ndr_print_uint8(ndr, idx, data[i]);
782 void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
784 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, r.length);
786 dump_data(10, r.data, r.length);
792 push a DATA_BLOB onto the wire.
794 NTSTATUS ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
796 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
797 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
798 blob.length = NDR_ALIGN(ndr, 2);
799 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
800 blob.length = NDR_ALIGN(ndr, 4);
801 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
802 blob.length = NDR_ALIGN(ndr, 8);
804 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
805 data_blob_clear(&blob);
806 } else if (!(ndr->flags & LIBNDR_FLAG_REMAINING)) {
807 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, blob.length));
809 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
814 pull a DATA_BLOB from the wire.
816 NTSTATUS ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
820 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
821 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
822 length = NDR_ALIGN(ndr, 2);
823 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
824 length = NDR_ALIGN(ndr, 4);
825 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
826 length = NDR_ALIGN(ndr, 8);
828 if (ndr->data_size - ndr->offset < length) {
829 length = ndr->data_size - ndr->offset;
831 } else if (ndr->flags & LIBNDR_FLAG_REMAINING) {
832 length = ndr->data_size - ndr->offset;
834 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
836 NDR_PULL_NEED_BYTES(ndr, length);
837 *blob = data_blob_talloc(ndr->current_mem_ctx, ndr->data+ndr->offset, length);
838 ndr->offset += length;
842 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
844 if (!data) return ret;
845 return ret + data->length;