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_BE(ndr) (((ndr)->flags & (LIBNDR_FLAG_BIGENDIAN|LIBNDR_FLAG_LITTLE_ENDIAN)) == LIBNDR_FLAG_BIGENDIAN)
27 #define NDR_SVAL(ndr, ofs) (NDR_BE(ndr)?RSVAL(ndr->data,ofs):SVAL(ndr->data,ofs))
28 #define NDR_IVAL(ndr, ofs) (NDR_BE(ndr)?RIVAL(ndr->data,ofs):IVAL(ndr->data,ofs))
29 #define NDR_IVALS(ndr, ofs) (NDR_BE(ndr)?RIVALS(ndr->data,ofs):IVALS(ndr->data,ofs))
30 #define NDR_SSVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSSVAL(ndr->data,ofs,v); } else SSVAL(ndr->data,ofs,v); } while (0)
31 #define NDR_SIVAL(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVAL(ndr->data,ofs,v); } else SIVAL(ndr->data,ofs,v); } while (0)
32 #define NDR_SIVALS(ndr, ofs, v) do { if (NDR_BE(ndr)) { RSIVALS(ndr->data,ofs,v); } else SIVALS(ndr->data,ofs,v); } while (0)
36 check for data leaks from the server by looking for non-zero pad bytes
37 these could also indicate that real structure elements have been
38 mistaken for padding in the IDL
40 void ndr_check_padding(struct ndr_pull *ndr, size_t n)
42 size_t ofs2 = (ndr->offset + (n-1)) & ~(n-1);
44 for (i=ndr->offset;i<ofs2;i++) {
45 if (ndr->data[i] != 0) {
50 DEBUG(0,("WARNING: Non-zero padding to %d: ", n));
51 for (i=ndr->offset;i<ofs2;i++) {
52 DEBUG(0,("%02x ", ndr->data[i]));
62 NTSTATUS ndr_pull_int8(struct ndr_pull *ndr, int ndr_flags, int8_t *v)
64 NDR_PULL_NEED_BYTES(ndr, 1);
65 *v = (int8_t)CVAL(ndr->data, ndr->offset);
73 NTSTATUS ndr_pull_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
75 NDR_PULL_NEED_BYTES(ndr, 1);
76 *v = CVAL(ndr->data, ndr->offset);
84 NTSTATUS ndr_pull_int16(struct ndr_pull *ndr, int ndr_flags, int16_t *v)
86 NDR_PULL_ALIGN(ndr, 2);
87 NDR_PULL_NEED_BYTES(ndr, 2);
88 *v = (uint16_t)NDR_SVAL(ndr, ndr->offset);
96 NTSTATUS ndr_pull_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
98 NDR_PULL_ALIGN(ndr, 2);
99 NDR_PULL_NEED_BYTES(ndr, 2);
100 *v = NDR_SVAL(ndr, ndr->offset);
108 NTSTATUS ndr_pull_int32(struct ndr_pull *ndr, int ndr_flags, int32_t *v)
110 NDR_PULL_ALIGN(ndr, 4);
111 NDR_PULL_NEED_BYTES(ndr, 4);
112 *v = NDR_IVALS(ndr, ndr->offset);
120 NTSTATUS ndr_pull_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
122 NDR_PULL_ALIGN(ndr, 4);
123 NDR_PULL_NEED_BYTES(ndr, 4);
124 *v = NDR_IVAL(ndr, ndr->offset);
130 parse a pointer referent identifier
132 NTSTATUS ndr_pull_unique_ptr(struct ndr_pull *ndr, uint32_t *v)
135 status = ndr_pull_uint32(ndr, NDR_SCALARS, v);
143 parse a ref pointer referent identifier
145 NTSTATUS ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
148 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, v));
149 /* ref pointers always point to data */
157 NTSTATUS ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
159 NDR_PULL_ALIGN(ndr, 4);
160 NDR_PULL_NEED_BYTES(ndr, 8);
161 *v = NDR_IVAL(ndr, ndr->offset);
162 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
170 NTSTATUS ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
172 NDR_PULL_ALIGN(ndr, 4);
173 NDR_PULL_NEED_BYTES(ndr, 8);
174 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
175 *v |= NDR_IVAL(ndr, ndr->offset+4);
183 NTSTATUS ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
185 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
191 NTSTATUS ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
193 NDR_PULL_ALIGN(ndr, 8);
194 return ndr_pull_udlong(ndr, ndr_flags, v);
200 NTSTATUS ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
203 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
204 *status = NT_STATUS(v);
211 NTSTATUS ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
213 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
216 void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
218 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
224 NTSTATUS ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
227 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
228 *status = W_ERROR(v);
235 NTSTATUS ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
237 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
240 void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
242 ndr->print(ndr, "%-25s: %s", name, win_errstr(r));
248 NTSTATUS ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
250 NDR_PULL_NEED_BYTES(ndr, n);
251 memcpy(data, ndr->data + ndr->offset, n);
257 pull an array of uint8
259 NTSTATUS ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
261 if (!(ndr_flags & NDR_SCALARS)) {
264 return ndr_pull_bytes(ndr, data, n);
268 pull an array of uint16
270 NTSTATUS ndr_pull_array_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *data, uint32_t n)
273 if (!(ndr_flags & NDR_SCALARS)) {
277 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &data[i]));
283 pull a const array of uint32_t
285 NTSTATUS ndr_pull_array_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *data, uint32_t n)
288 if (!(ndr_flags & NDR_SCALARS)) {
292 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &data[i]));
298 pull a const array of hyper
300 NTSTATUS ndr_pull_array_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *data, uint32_t n)
303 if (!(ndr_flags & NDR_SCALARS)) {
307 NDR_CHECK(ndr_pull_hyper(ndr, NDR_SCALARS, &data[i]));
313 pull a const array of WERROR
315 NTSTATUS ndr_pull_array_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *data, uint32_t n)
318 if (!(ndr_flags & NDR_SCALARS)) {
322 NDR_CHECK(ndr_pull_WERROR(ndr, NDR_SCALARS, &data[i]));
330 NTSTATUS ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
332 NDR_PUSH_NEED_BYTES(ndr, 1);
333 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
341 NTSTATUS ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
343 NDR_PUSH_NEED_BYTES(ndr, 1);
344 SCVAL(ndr->data, ndr->offset, v);
352 NTSTATUS ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
354 NDR_PUSH_ALIGN(ndr, 2);
355 NDR_PUSH_NEED_BYTES(ndr, 2);
356 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
364 NTSTATUS ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
366 NDR_PUSH_ALIGN(ndr, 2);
367 NDR_PUSH_NEED_BYTES(ndr, 2);
368 NDR_SSVAL(ndr, ndr->offset, v);
376 NTSTATUS ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
378 NDR_PUSH_ALIGN(ndr, 4);
379 NDR_PUSH_NEED_BYTES(ndr, 4);
380 NDR_SIVALS(ndr, ndr->offset, v);
388 NTSTATUS ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
390 NDR_PUSH_ALIGN(ndr, 4);
391 NDR_PUSH_NEED_BYTES(ndr, 4);
392 NDR_SIVAL(ndr, ndr->offset, v);
400 NTSTATUS ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
402 NDR_PUSH_ALIGN(ndr, 4);
403 NDR_PUSH_NEED_BYTES(ndr, 8);
404 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
405 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
413 NTSTATUS ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
415 NDR_PUSH_ALIGN(ndr, 4);
416 NDR_PUSH_NEED_BYTES(ndr, 8);
417 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
418 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
426 NTSTATUS ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
428 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
434 NTSTATUS ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
436 NDR_PUSH_ALIGN(ndr, 8);
437 return ndr_push_udlong(ndr, NDR_SCALARS, v);
440 NTSTATUS ndr_push_align(struct ndr_push *ndr, size_t size)
442 NDR_PUSH_ALIGN(ndr, size);
446 NTSTATUS ndr_pull_align(struct ndr_pull *ndr, size_t size)
448 NDR_PULL_ALIGN(ndr, size);
455 NTSTATUS ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
457 NDR_PUSH_NEED_BYTES(ndr, n);
458 memcpy(ndr->data + ndr->offset, data, n);
466 NTSTATUS ndr_push_zero(struct ndr_push *ndr, uint32_t n)
468 NDR_PUSH_NEED_BYTES(ndr, n);
469 memset(ndr->data + ndr->offset, 0, n);
475 push an array of uint8
477 NTSTATUS ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
479 if (!(ndr_flags & NDR_SCALARS)) {
482 return ndr_push_bytes(ndr, data, n);
486 push an array of uint16
488 NTSTATUS ndr_push_array_uint16(struct ndr_push *ndr, int ndr_flags, const uint16_t *data, uint32_t n)
491 if (!(ndr_flags & NDR_SCALARS)) {
495 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, data[i]));
501 push an array of uint32_t
503 NTSTATUS ndr_push_array_uint32(struct ndr_push *ndr, int ndr_flags, const uint32_t *data, uint32_t n)
506 if (!(ndr_flags & NDR_SCALARS)) {
510 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, data[i]));
516 push an array of hyper
518 NTSTATUS ndr_push_array_hyper(struct ndr_push *ndr, int ndr_flags, const uint64_t *data, uint32_t n)
521 if (!(ndr_flags & NDR_SCALARS)) {
525 NDR_CHECK(ndr_push_hyper(ndr, NDR_SCALARS, data[i]));
531 push an array of hyper
533 NTSTATUS ndr_push_array_WERROR(struct ndr_push *ndr, int ndr_flags, const WERROR *data, uint32_t n)
536 if (!(ndr_flags & NDR_SCALARS)) {
540 NDR_CHECK(ndr_push_WERROR(ndr, NDR_SCALARS, data[i]));
546 save the current position
548 void ndr_push_save(struct ndr_push *ndr, struct ndr_push_save *save)
550 save->offset = ndr->offset;
556 void ndr_push_restore(struct ndr_push *ndr, struct ndr_push_save *save)
558 ndr->offset = save->offset;
562 push a unique non-zero value if a pointer is non-NULL, otherwise 0
564 NTSTATUS ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
569 ptr = ndr->ptr_count;
571 return ndr_push_uint32(ndr, NDR_SCALARS, ptr);
575 push always a 0, if a pointer is NULL it's a fatal error
577 NTSTATUS ndr_push_ref_ptr(struct ndr_push *ndr, const void *p)
580 return NT_STATUS_INVALID_PARAMETER_MIX;
582 return ndr_push_uint32(ndr, NDR_SCALARS, 0);
586 pull a general string from the wire
588 NTSTATUS ndr_pull_string(struct ndr_pull *ndr, int ndr_flags, const char **s)
591 uint32_t len1, ofs, len2;
594 int chset = CH_UTF16;
595 unsigned byte_mul = 2;
596 unsigned flags = ndr->flags;
597 unsigned c_len_term = 0;
599 if (!(ndr_flags & NDR_SCALARS)) {
607 if (flags & LIBNDR_FLAG_STR_ASCII) {
610 flags &= ~LIBNDR_FLAG_STR_ASCII;
613 if (flags & LIBNDR_FLAG_STR_UTF8) {
616 flags &= ~LIBNDR_FLAG_STR_UTF8;
619 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
620 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
622 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
625 switch (flags & LIBNDR_STRING_FLAGS) {
626 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
627 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
628 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
629 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
631 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
632 ndr->flags & LIBNDR_STRING_FLAGS);
634 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len2));
636 return ndr_pull_error(ndr, NDR_ERR_STRING,
637 "Bad string lengths len1=%u ofs=%u len2=%u\n",
641 *s = talloc_strdup(ndr, "");
644 NDR_PULL_NEED_BYTES(ndr, (len2 + c_len_term)*byte_mul);
645 ret = convert_string_talloc(ndr, chset, CH_UNIX,
646 ndr->data+ndr->offset,
647 (len2 + c_len_term)*byte_mul,
650 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
651 "Bad character conversion");
653 NDR_CHECK(ndr_pull_advance(ndr, (len2 + c_len_term)*byte_mul));
655 /* this is a way of detecting if a string is sent with the wrong
657 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
658 if (strlen(as) < (len2 + c_len_term)) {
659 DEBUG(6,("short string '%s'\n", as));
662 if (strlen(as) == (len2 + c_len_term)) {
663 DEBUG(6,("long string '%s'\n", as));
669 case LIBNDR_FLAG_STR_SIZE4:
670 case LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
671 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
672 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
674 *s = talloc_strdup(ndr, "");
677 ret = convert_string_talloc(ndr, chset, CH_UNIX,
678 ndr->data+ndr->offset,
679 (len1 + c_len_term)*byte_mul,
682 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
683 "Bad character conversion");
685 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
687 /* this is a way of detecting if a string is sent with the wrong
689 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
690 if (strlen(as) < (len1 + c_len_term)) {
691 DEBUG(6,("short string '%s'\n", as));
694 if (strlen(as) == (len1 + c_len_term)) {
695 DEBUG(6,("long string '%s'\n", as));
701 case LIBNDR_FLAG_STR_LEN4:
702 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_NOTERM:
703 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
705 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
706 ndr->flags & LIBNDR_STRING_FLAGS);
708 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
709 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
711 *s = talloc_strdup(ndr, "");
714 ret = convert_string_talloc(ndr, chset, CH_UNIX,
715 ndr->data+ndr->offset,
716 (len1 + c_len_term)*byte_mul,
719 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
720 "Bad character conversion");
722 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
724 /* this is a way of detecting if a string is sent with the wrong
726 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
727 if (strlen(as) < (len1 + c_len_term)) {
728 DEBUG(6,("short string '%s'\n", as));
731 if (strlen(as) == (len1 + c_len_term)) {
732 DEBUG(6,("long string '%s'\n", as));
739 case LIBNDR_FLAG_STR_SIZE2:
740 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM:
741 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
742 NDR_PULL_NEED_BYTES(ndr, (len3 + c_len_term)*byte_mul);
744 *s = talloc_strdup(ndr, "");
747 ret = convert_string_talloc(ndr, chset, CH_UNIX,
748 ndr->data+ndr->offset,
749 (len3 + c_len_term)*byte_mul,
752 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
753 "Bad character conversion");
755 NDR_CHECK(ndr_pull_advance(ndr, (len3 + c_len_term)*byte_mul));
757 /* this is a way of detecting if a string is sent with the wrong
759 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
760 if (strlen(as) < (len3 + c_len_term)) {
761 DEBUG(6,("short string '%s'\n", as));
764 if (strlen(as) == (len3 + c_len_term)) {
765 DEBUG(6,("long string '%s'\n", as));
771 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
772 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
773 NDR_PULL_NEED_BYTES(ndr, len3);
775 *s = talloc_strdup(ndr, "");
778 ret = convert_string_talloc(ndr, chset, CH_UNIX,
779 ndr->data+ndr->offset,
783 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
784 "Bad character conversion");
786 NDR_CHECK(ndr_pull_advance(ndr, len3));
790 case LIBNDR_FLAG_STR_NULLTERM:
792 len1 = ascii_len_n((const char *)(ndr->data+ndr->offset), ndr->data_size - ndr->offset);
794 len1 = utf16_len_n(ndr->data+ndr->offset, ndr->data_size - ndr->offset);
796 ret = convert_string_talloc(ndr, chset, CH_UNIX,
797 ndr->data+ndr->offset,
801 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
802 "Bad character conversion");
804 NDR_CHECK(ndr_pull_advance(ndr, len1));
808 case LIBNDR_FLAG_STR_FIXLEN15:
809 case LIBNDR_FLAG_STR_FIXLEN32:
810 len1 = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
811 NDR_PULL_NEED_BYTES(ndr, len1*byte_mul);
812 ret = convert_string_talloc(ndr, chset, CH_UNIX,
813 ndr->data+ndr->offset,
817 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
818 "Bad character conversion");
820 NDR_CHECK(ndr_pull_advance(ndr, len1*byte_mul));
825 return ndr_pull_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
826 ndr->flags & LIBNDR_STRING_FLAGS);
834 push a general string onto the wire
836 NTSTATUS ndr_push_string(struct ndr_push *ndr, int ndr_flags, const char *s)
838 ssize_t s_len, c_len, d_len;
840 int chset = CH_UTF16;
841 unsigned flags = ndr->flags;
842 unsigned byte_mul = 2;
843 unsigned c_len_term = 1;
845 if (!(ndr_flags & NDR_SCALARS)) {
853 s_len = s?strlen(s):0;
854 c_len = s?strlen_m(s):0;
856 if (flags & LIBNDR_FLAG_STR_ASCII) {
859 flags &= ~LIBNDR_FLAG_STR_ASCII;
862 if (flags & LIBNDR_FLAG_STR_UTF8) {
865 flags &= ~LIBNDR_FLAG_STR_UTF8;
868 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
870 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
872 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
875 switch (flags & LIBNDR_STRING_FLAGS) {
876 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
877 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
878 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
879 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
880 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
881 ret = convert_string(CH_UNIX, chset,
883 ndr->data+ndr->offset,
886 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
887 "Bad character conversion");
889 ndr->offset += byte_mul*(c_len+1);
892 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
893 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
894 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
895 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
896 NDR_PUSH_NEED_BYTES(ndr, c_len*byte_mul);
897 ret = convert_string(CH_UNIX, chset,
899 ndr->data+ndr->offset, c_len*byte_mul);
901 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
902 "Bad character conversion");
904 ndr->offset += c_len*byte_mul;
907 case LIBNDR_FLAG_STR_LEN4:
908 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
909 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len + c_len_term));
910 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
911 ret = convert_string(CH_UNIX, chset,
913 ndr->data+ndr->offset, byte_mul*(c_len+1));
915 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
916 "Bad character conversion");
918 ndr->offset += byte_mul*(c_len+1);
921 case LIBNDR_FLAG_STR_SIZE4:
922 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len + c_len_term));
923 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
924 ret = convert_string(CH_UNIX, chset,
926 ndr->data+ndr->offset, byte_mul*(c_len+1));
928 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
929 "Bad character conversion");
931 ndr->offset += byte_mul*(c_len+1);
934 case LIBNDR_FLAG_STR_SIZE2:
935 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len + c_len_term));
936 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
937 ret = convert_string(CH_UNIX, chset,
939 ndr->data+ndr->offset, byte_mul*(c_len+1));
941 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
942 "Bad character conversion");
944 ndr->offset += byte_mul*(c_len+1);
947 case LIBNDR_FLAG_STR_NULLTERM:
948 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
949 ret = convert_string(CH_UNIX, chset,
951 ndr->data+ndr->offset, byte_mul*(c_len+1));
953 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
954 "Bad character conversion");
956 ndr->offset += byte_mul*(c_len+1);
959 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
960 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len*byte_mul));
961 NDR_PUSH_NEED_BYTES(ndr, c_len*byte_mul);
962 ret = convert_string(CH_UNIX, chset,
964 ndr->data+ndr->offset, c_len*byte_mul);
966 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
967 "Bad character conversion");
969 ndr->offset += c_len*byte_mul;
972 case LIBNDR_FLAG_STR_FIXLEN15:
973 case LIBNDR_FLAG_STR_FIXLEN32:
974 d_len = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
975 NDR_PUSH_NEED_BYTES(ndr, byte_mul*d_len);
976 ret = convert_string(CH_UNIX, chset,
978 ndr->data+ndr->offset, byte_mul*d_len);
980 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
981 "Bad character conversion");
983 ndr->offset += byte_mul*d_len;
987 return ndr_push_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
988 ndr->flags & LIBNDR_STRING_FLAGS);
995 push a general string onto the wire
997 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s)
1000 unsigned flags = ndr->flags;
1001 unsigned byte_mul = 2;
1002 unsigned c_len_term = 1;
1004 if (flags & LIBNDR_FLAG_STR_FIXLEN32) {
1007 if (flags & LIBNDR_FLAG_STR_FIXLEN15) {
1011 c_len = s?strlen_m(s):0;
1013 if (flags & (LIBNDR_FLAG_STR_ASCII|LIBNDR_FLAG_STR_UTF8)) {
1017 if (flags & LIBNDR_FLAG_STR_NOTERM) {
1021 c_len = c_len + c_len_term;
1023 if (flags & LIBNDR_FLAG_STR_BYTESIZE) {
1024 c_len = c_len * byte_mul;
1034 NTSTATUS ndr_push_NTTIME(struct ndr_push *ndr, int ndr_flags, NTTIME t)
1036 NDR_CHECK(ndr_push_udlong(ndr, ndr_flags, t));
1037 return NT_STATUS_OK;
1043 NTSTATUS ndr_pull_NTTIME(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
1045 NDR_CHECK(ndr_pull_udlong(ndr, ndr_flags, t));
1046 return NT_STATUS_OK;
1052 NTSTATUS ndr_push_NTTIME_1sec(struct ndr_push *ndr, int ndr_flags, NTTIME t)
1055 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
1056 return NT_STATUS_OK;
1062 NTSTATUS ndr_pull_NTTIME_1sec(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
1064 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
1066 return NT_STATUS_OK;
1072 NTSTATUS ndr_pull_NTTIME_hyper(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
1074 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
1075 return NT_STATUS_OK;
1081 NTSTATUS ndr_push_NTTIME_hyper(struct ndr_push *ndr, int ndr_flags, NTTIME t)
1083 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
1084 return NT_STATUS_OK;
1090 NTSTATUS ndr_push_time_t(struct ndr_push *ndr, int ndr_flags, time_t t)
1092 return ndr_push_uint32(ndr, ndr_flags, t);
1098 NTSTATUS ndr_pull_time_t(struct ndr_pull *ndr, int ndr_flags, time_t *t)
1101 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &tt));
1103 return NT_STATUS_OK;
1110 NTSTATUS ndr_pull_ipv4address(struct ndr_pull *ndr, int ndr_flags, const char **address)
1112 struct ipv4_addr in;
1113 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &in.addr));
1114 in.addr = htonl(in.addr);
1115 *address = talloc_strdup(ndr, sys_inet_ntoa(in));
1116 NT_STATUS_HAVE_NO_MEMORY(*address);
1117 return NT_STATUS_OK;
1123 NTSTATUS ndr_push_ipv4address(struct ndr_push *ndr, int ndr_flags, const char *address)
1125 uint32_t addr = interpret_addr(address);
1126 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, htonl(addr)));
1127 return NT_STATUS_OK;
1133 void ndr_print_ipv4address(struct ndr_print *ndr, const char *name,
1134 const char *address)
1136 ndr->print(ndr, "%-25s: %s", name, address);
1140 void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
1142 ndr->print(ndr, "%s: struct %s", name, type);
1145 void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
1146 const char *val, uint_t value)
1148 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
1149 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
1151 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
1155 void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint_t flag, uint_t value)
1157 /* this is an attempt to support multi-bit bitmap masks */
1160 while (!(flag & 1)) {
1165 ndr->print(ndr, " %d: %-25s", value, flag_name);
1167 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
1171 void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
1173 ndr->print(ndr, "%-25s: %d", name, v);
1176 void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
1178 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
1181 void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
1183 ndr->print(ndr, "%-25s: %d", name, v);
1186 void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
1188 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
1191 void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
1193 ndr->print(ndr, "%-25s: %d", name, v);
1196 void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
1198 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
1201 void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
1203 ndr->print(ndr, "%-25s: 0x%08x%08x (%llu)", name,
1204 (uint32_t)(v >> 32),
1205 (uint32_t)(v & 0xFFFFFFFF),
1209 void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
1211 ndr_print_udlong(ndr, name, v);
1214 void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
1216 ndr->print(ndr, "%-25s: 0x%08x%08x (%lld)", name,
1217 (uint32_t)(v >> 32),
1218 (uint32_t)(v & 0xFFFFFFFF),
1222 void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
1224 ndr_print_dlong(ndr, name, v);
1227 void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
1230 ndr->print(ndr, "%-25s: *", name);
1232 ndr->print(ndr, "%-25s: NULL", name);
1236 void ndr_print_string(struct ndr_print *ndr, const char *name, const char *s)
1239 ndr->print(ndr, "%-25s: '%s'", name, s);
1241 ndr->print(ndr, "%-25s: NULL", name);
1245 void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
1247 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
1250 void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
1252 /* this is a standard NTTIME here
1253 * as it's already converted in the pull/push code
1255 ndr_print_NTTIME(ndr, name, t);
1258 void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
1260 ndr_print_NTTIME(ndr, name, t);
1263 void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
1265 if (t == (time_t)-1 || t == 0) {
1266 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
1268 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
1272 void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
1274 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
1277 void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
1279 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
1282 void ndr_print_array_WERROR(struct ndr_print *ndr, const char *name,
1283 const WERROR *data, uint32_t count)
1287 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
1289 for (i=0;i<count;i++) {
1291 asprintf(&idx, "[%d]", i);
1293 ndr_print_WERROR(ndr, idx, data[i]);
1300 void ndr_print_array_hyper(struct ndr_print *ndr, const char *name,
1301 const uint64_t *data, uint32_t count)
1305 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
1307 for (i=0;i<count;i++) {
1309 asprintf(&idx, "[%d]", i);
1311 ndr_print_hyper(ndr, idx, data[i]);
1318 void ndr_print_array_uint32(struct ndr_print *ndr, const char *name,
1319 const uint32_t *data, uint32_t count)
1323 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
1325 for (i=0;i<count;i++) {
1327 asprintf(&idx, "[%d]", i);
1329 ndr_print_uint32(ndr, idx, data[i]);
1336 void ndr_print_array_uint16(struct ndr_print *ndr, const char *name,
1337 const uint16_t *data, uint32_t count)
1341 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
1343 for (i=0;i<count;i++) {
1345 asprintf(&idx, "[%d]", i);
1347 ndr_print_uint16(ndr, idx, data[i]);
1354 void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
1355 const uint8_t *data, uint32_t count)
1359 if (count <= 600 && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
1361 for (i=0;i<count;i++) {
1362 snprintf(&s[i*2], 3, "%02x", data[i]);
1365 ndr->print(ndr, "%-25s: %s", name, s);
1369 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
1371 for (i=0;i<count;i++) {
1373 asprintf(&idx, "[%d]", i);
1375 ndr_print_uint8(ndr, idx, data[i]);
1382 void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
1384 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, r.length);
1386 dump_data(10, r.data, r.length);
1392 push a DATA_BLOB onto the wire.
1394 NTSTATUS ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
1396 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
1397 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
1398 blob.length = NDR_ALIGN(ndr, 2);
1399 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
1400 blob.length = NDR_ALIGN(ndr, 4);
1401 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
1402 blob.length = NDR_ALIGN(ndr, 8);
1404 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
1405 data_blob_clear(&blob);
1406 } else if (!(ndr->flags & LIBNDR_FLAG_REMAINING)) {
1407 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, blob.length));
1409 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
1410 return NT_STATUS_OK;
1414 pull a DATA_BLOB from the wire.
1416 NTSTATUS ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
1420 if (ndr->flags & LIBNDR_ALIGN_FLAGS) {
1421 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
1422 length = NDR_ALIGN(ndr, 2);
1423 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
1424 length = NDR_ALIGN(ndr, 4);
1425 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
1426 length = NDR_ALIGN(ndr, 8);
1428 if (ndr->data_size - ndr->offset < length) {
1429 length = ndr->data_size - ndr->offset;
1431 } else if (ndr->flags & LIBNDR_FLAG_REMAINING) {
1432 length = ndr->data_size - ndr->offset;
1434 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &length));
1436 NDR_PULL_NEED_BYTES(ndr, length);
1437 *blob = data_blob_talloc(ndr, ndr->data+ndr->offset, length);
1438 ndr->offset += length;
1439 return NT_STATUS_OK;
1442 uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
1444 return ret + data->length;
1447 uint32_t ndr_size_string(int ret, const char * const* string, int flags)
1449 /* FIXME: Is this correct for all strings ? */
1450 if(!(*string)) return ret;
1451 return ret+strlen(*string)+1;