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.
24 #include "system/network.h"
26 #define NDR_SVAL(ndr, ofs) (NDR_BE(ndr)?RSVAL(ndr->data,ofs):SVAL(ndr->data,ofs))
27 #define NDR_IVAL(ndr, ofs) (NDR_BE(ndr)?RIVAL(ndr->data,ofs):IVAL(ndr->data,ofs))
28 #define NDR_IVALS(ndr, ofs) (NDR_BE(ndr)?RIVALS(ndr->data,ofs):IVALS(ndr->data,ofs))
29 #define NDR_SSVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSSVAL(ndr->data,ofs,v); } else SSVAL(ndr->data,ofs,v); } while (0)
30 #define NDR_SIVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVAL(ndr->data,ofs,v); } else SIVAL(ndr->data,ofs,v); } while (0)
31 #define NDR_SIVALS(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVALS(ndr->data,ofs,v); } else SIVALS(ndr->data,ofs,v); } while (0)
35 check for data leaks from the server by looking for non-zero pad bytes
36 these could also indicate that real structure elements have been
37 mistaken for padding in the IDL
39 void ndr_check_padding(struct ndr_pull *ndr, size_t n)
41 size_t ofs2 = (ndr->offset + (n-1)) & ~(n-1);
43 for (i=ndr->offset;i<ofs2;i++) {
44 if (ndr->data[i] != 0) {
49 DEBUG(0,("WARNING: Non-zero padding to %d: ", (int)n));
50 for (i=ndr->offset;i<ofs2;i++) {
51 DEBUG(0,("%02x ", ndr->data[i]));
61 NTSTATUS ndr_pull_int8(struct ndr_pull *ndr, int ndr_flags, int8_t *v)
63 NDR_PULL_NEED_BYTES(ndr, 1);
64 *v = (int8_t)CVAL(ndr->data, ndr->offset);
72 NTSTATUS ndr_pull_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
74 NDR_PULL_NEED_BYTES(ndr, 1);
75 *v = CVAL(ndr->data, ndr->offset);
83 NTSTATUS ndr_pull_int16(struct ndr_pull *ndr, int ndr_flags, int16_t *v)
85 NDR_PULL_ALIGN(ndr, 2);
86 NDR_PULL_NEED_BYTES(ndr, 2);
87 *v = (uint16_t)NDR_SVAL(ndr, ndr->offset);
95 NTSTATUS ndr_pull_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
97 NDR_PULL_ALIGN(ndr, 2);
98 NDR_PULL_NEED_BYTES(ndr, 2);
99 *v = NDR_SVAL(ndr, ndr->offset);
107 NTSTATUS ndr_pull_int32(struct ndr_pull *ndr, int ndr_flags, int32_t *v)
109 NDR_PULL_ALIGN(ndr, 4);
110 NDR_PULL_NEED_BYTES(ndr, 4);
111 *v = NDR_IVALS(ndr, ndr->offset);
119 NTSTATUS ndr_pull_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
121 NDR_PULL_ALIGN(ndr, 4);
122 NDR_PULL_NEED_BYTES(ndr, 4);
123 *v = NDR_IVAL(ndr, ndr->offset);
129 parse a pointer referent identifier
131 NTSTATUS ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v)
134 status = ndr_pull_uint32(ndr, NDR_SCALARS, v);
135 if (NT_STATUS_IS_OK(status) && *v != 0) {
142 parse a ref pointer referent identifier
144 NTSTATUS ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
146 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
147 /* ref pointers always point to data */
155 NTSTATUS ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
157 NDR_PULL_ALIGN(ndr, 4);
158 NDR_PULL_NEED_BYTES(ndr, 8);
159 *v = NDR_IVAL(ndr, ndr->offset);
160 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
168 NTSTATUS ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
170 NDR_PULL_ALIGN(ndr, 4);
171 NDR_PULL_NEED_BYTES(ndr, 8);
172 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
173 *v |= NDR_IVAL(ndr, ndr->offset+4);
181 NTSTATUS ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
183 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
189 NTSTATUS ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
191 NDR_PULL_ALIGN(ndr, 8);
192 return ndr_pull_udlong(ndr, ndr_flags, v);
198 NTSTATUS ndr_pull_pointer(struct ndr_pull *ndr, int ndr_flags, void* *v)
201 NDR_PULL_ALIGN(ndr, sizeof(h));
202 NDR_PULL_NEED_BYTES(ndr, sizeof(h));
203 memcpy(&h, ndr->data+ndr->offset, sizeof(h));
204 ndr->offset += sizeof(h);
212 NTSTATUS ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
215 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
216 *status = NT_STATUS(v);
223 NTSTATUS ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
225 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
228 void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
230 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
236 NTSTATUS ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
239 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
240 *status = W_ERROR(v);
247 NTSTATUS ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
249 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
252 void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
254 ndr->print(ndr, "%-25s: %s", name, win_errstr(r));
260 NTSTATUS ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
262 NDR_PULL_NEED_BYTES(ndr, n);
263 memcpy(data, ndr->data + ndr->offset, n);
269 pull an array of uint8
271 NTSTATUS ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
273 if (!(ndr_flags & NDR_SCALARS)) {
276 return ndr_pull_bytes(ndr, data, n);
282 NTSTATUS ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
284 NDR_PUSH_NEED_BYTES(ndr, 1);
285 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
293 NTSTATUS ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
295 NDR_PUSH_NEED_BYTES(ndr, 1);
296 SCVAL(ndr->data, ndr->offset, v);
304 NTSTATUS ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
306 NDR_PUSH_ALIGN(ndr, 2);
307 NDR_PUSH_NEED_BYTES(ndr, 2);
308 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
316 NTSTATUS ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
318 NDR_PUSH_ALIGN(ndr, 2);
319 NDR_PUSH_NEED_BYTES(ndr, 2);
320 NDR_SSVAL(ndr, ndr->offset, v);
328 NTSTATUS ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
330 NDR_PUSH_ALIGN(ndr, 4);
331 NDR_PUSH_NEED_BYTES(ndr, 4);
332 NDR_SIVALS(ndr, ndr->offset, v);
340 NTSTATUS ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
342 NDR_PUSH_ALIGN(ndr, 4);
343 NDR_PUSH_NEED_BYTES(ndr, 4);
344 NDR_SIVAL(ndr, ndr->offset, v);
352 NTSTATUS ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
354 NDR_PUSH_ALIGN(ndr, 4);
355 NDR_PUSH_NEED_BYTES(ndr, 8);
356 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
357 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
365 NTSTATUS ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
367 NDR_PUSH_ALIGN(ndr, 4);
368 NDR_PUSH_NEED_BYTES(ndr, 8);
369 NDR_SIVAL(ndr, ndr->offset, (v>>32));
370 NDR_SIVAL(ndr, ndr->offset+4, (v & 0xFFFFFFFF));
378 NTSTATUS ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
380 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
386 NTSTATUS ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
388 NDR_PUSH_ALIGN(ndr, 8);
389 return ndr_push_udlong(ndr, NDR_SCALARS, v);
395 NTSTATUS ndr_push_pointer(struct ndr_push *ndr, int ndr_flags, void* v)
397 intptr_t h = (intptr_t)v;
398 NDR_PUSH_ALIGN(ndr, sizeof(h));
399 NDR_PUSH_NEED_BYTES(ndr, sizeof(h));
400 memcpy(ndr->data+ndr->offset, &h, sizeof(h));
401 ndr->offset += sizeof(h);
405 NTSTATUS ndr_push_align(struct ndr_push *ndr, size_t size)
407 NDR_PUSH_ALIGN(ndr, size);
411 NTSTATUS ndr_pull_align(struct ndr_pull *ndr, size_t size)
413 NDR_PULL_ALIGN(ndr, size);
420 NTSTATUS ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
422 NDR_PUSH_NEED_BYTES(ndr, n);
423 memcpy(ndr->data + ndr->offset, data, n);
431 NTSTATUS ndr_push_zero(struct ndr_push *ndr, uint32_t n)
433 NDR_PUSH_NEED_BYTES(ndr, n);
434 memset(ndr->data + ndr->offset, 0, n);
440 push an array of uint8
442 NTSTATUS ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
444 if (!(ndr_flags & NDR_SCALARS)) {
447 return ndr_push_bytes(ndr, data, n);
451 save the current position
453 void ndr_push_save(struct ndr_push *ndr, struct ndr_push_save *save)
455 save->offset = ndr->offset;
461 void ndr_push_restore(struct ndr_push *ndr, struct ndr_push_save *save)
463 ndr->offset = save->offset;
467 push a unique non-zero value if a pointer is non-NULL, otherwise 0
469 NTSTATUS ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
473 ptr = ndr->ptr_count * 4;
477 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
481 push a 'simple' full non-zero value if a pointer is non-NULL, otherwise 0
483 NTSTATUS ndr_push_sptr_ptr(struct ndr_push *ndr, const void *p)
488 ptr = ndr->ptr_count;
490 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
494 push always a 0, if a pointer is NULL it's a fatal error
496 NTSTATUS ndr_push_ref_ptr(struct ndr_push *ndr, const void *p)
499 return NT_STATUS_INVALID_PARAMETER_MIX;
501 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));
584 NTSTATUS ndr_pull_ipv4address(struct ndr_pull *ndr, int ndr_flags, const char **address)
587 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &in.addr));
588 in.addr = htonl(in.addr);
589 *address = talloc_strdup(ndr->current_mem_ctx, sys_inet_ntoa(in));
590 NT_STATUS_HAVE_NO_MEMORY(*address);
597 NTSTATUS ndr_push_ipv4address(struct ndr_push *ndr, int ndr_flags, const char *address)
600 if (!is_ipaddress(address)) {
601 return ndr_push_error(ndr, NDR_ERR_IPV4ADDRESS,
602 "Invalid IPv4 address: '%s'",
605 addr = inet_addr(address);
606 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, htonl(addr)));
613 void ndr_print_ipv4address(struct ndr_print *ndr, const char *name,
616 ndr->print(ndr, "%-25s: %s", name, address);
620 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
622 ndr->print(ndr, "%s: struct %s", name, type);
625 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
626 const char *val, uint_t value)
628 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
629 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
631 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
635 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint_t flag, uint_t value)
637 /* this is an attempt to support multi-bit bitmap masks */
640 while (!(flag & 1)) {
645 ndr->print(ndr, " %d: %-25s", value, flag_name);
647 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
651 void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
653 ndr->print(ndr, "%-25s: %d", name, v);
656 void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
658 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
661 void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
663 ndr->print(ndr, "%-25s: %d", name, v);
666 void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
668 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
671 void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
673 ndr->print(ndr, "%-25s: %d", name, v);
676 void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
678 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
681 void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
683 ndr->print(ndr, "%-25s: 0x%016llx (%llu)", name, v, v);
686 void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
688 ndr_print_udlong(ndr, name, v);
691 void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
693 ndr->print(ndr, "%-25s: 0x%016llx (%lld)", name, v, v);
696 void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
698 ndr_print_dlong(ndr, name, v);
701 void ndr_print_pointer(struct ndr_print *ndr, const char *name, void *v)
703 ndr->print(ndr, "%-25s: %p", name, v);
706 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
709 ndr->print(ndr, "%-25s: *", name);
711 ndr->print(ndr, "%-25s: NULL", name);
715 void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
717 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
720 void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
722 /* this is a standard NTTIME here
723 * as it's already converted in the pull/push code
725 ndr_print_NTTIME(ndr, name, t);
728 void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
730 ndr_print_NTTIME(ndr, name, t);
733 void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
735 if (t == (time_t)-1 || t == 0) {
736 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
738 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
742 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
744 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
745 ndr->print(ndr, "%-25s: union %s(case 0x%X)", name, type, level);
747 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
751 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
753 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
756 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
757 const uint8_t *data, uint32_t count)
761 if (count <= 600 && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
763 for (i=0;i<count;i++) {
764 snprintf(&s[i*2], 3, "%02x", data[i]);
767 ndr->print(ndr, "%-25s: %s", name, s);
771 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
773 for (i=0;i<count;i++) {
775 asprintf(&idx, "[%d]", i);
777 ndr_print_uint8(ndr, idx, data[i]);
784 void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
786 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, r.length);
788 dump_data(10, r.data, r.length);
794 push a DATA_BLOB onto the wire.
796 NTSTATUS ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
798 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
799 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
800 blob.length = NDR_ALIGN(ndr, 2);
801 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
802 blob.length = NDR_ALIGN(ndr, 4);
803 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
804 blob.length = NDR_ALIGN(ndr, 8);
806 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
807 data_blob_clear(&blob);
808 } else if (!(ndr->flags & LIBNDR_FLAG_REMAINING)) {
809 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, blob.length));
811 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
816 pull a DATA_BLOB from the wire.
818 NTSTATUS ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
822 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
823 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
824 length = NDR_ALIGN(ndr, 2);
825 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
826 length = NDR_ALIGN(ndr, 4);
827 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
828 length = NDR_ALIGN(ndr, 8);
830 if (ndr->data_size - ndr->offset < length) {
831 length = ndr->data_size - ndr->offset;
833 } else if (ndr->flags & LIBNDR_FLAG_REMAINING) {
834 length = ndr->data_size - ndr->offset;
836 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
838 NDR_PULL_NEED_BYTES(ndr, length);
839 *blob = data_blob_talloc(ndr->current_mem_ctx, ndr->data+ndr->offset, length);
840 ndr->offset += length;
844 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
846 return ret + data->length;