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/>.
23 #include "system/network.h"
24 #include "librpc/ndr/libndr.h"
25 #include "lib/util/util_net.h"
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)
35 static void ndr_dump_data(struct ndr_print *ndr, const uint8_t *buf, int len);
38 check for data leaks from the server by looking for non-zero pad bytes
39 these could also indicate that real structure elements have been
40 mistaken for padding in the IDL
42 _PUBLIC_ void ndr_check_padding(struct ndr_pull *ndr, size_t n)
44 size_t ofs2 = (ndr->offset + (n-1)) & ~(n-1);
46 for (i=ndr->offset;i<ofs2;i++) {
47 if (ndr->data[i] != 0) {
52 DEBUG(0,("WARNING: Non-zero padding to %d: ", (int)n));
53 for (i=ndr->offset;i<ofs2;i++) {
54 DEBUG(0,("%02x ", ndr->data[i]));
64 _PUBLIC_ enum ndr_err_code ndr_pull_int8(struct ndr_pull *ndr, int ndr_flags, int8_t *v)
66 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
67 NDR_PULL_NEED_BYTES(ndr, 1);
68 *v = (int8_t)CVAL(ndr->data, ndr->offset);
70 return NDR_ERR_SUCCESS;
76 _PUBLIC_ enum ndr_err_code ndr_pull_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
78 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
79 NDR_PULL_NEED_BYTES(ndr, 1);
80 *v = CVAL(ndr->data, ndr->offset);
82 return NDR_ERR_SUCCESS;
88 _PUBLIC_ enum ndr_err_code ndr_pull_int16(struct ndr_pull *ndr, int ndr_flags, int16_t *v)
90 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
91 NDR_PULL_ALIGN(ndr, 2);
92 NDR_PULL_NEED_BYTES(ndr, 2);
93 *v = (uint16_t)NDR_SVAL(ndr, ndr->offset);
95 return NDR_ERR_SUCCESS;
101 _PUBLIC_ enum ndr_err_code ndr_pull_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
103 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
104 NDR_PULL_ALIGN(ndr, 2);
105 NDR_PULL_NEED_BYTES(ndr, 2);
106 *v = NDR_SVAL(ndr, ndr->offset);
108 return NDR_ERR_SUCCESS;
114 _PUBLIC_ enum ndr_err_code ndr_pull_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
116 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
117 if (unlikely(ndr->flags & LIBNDR_FLAG_NDR64)) {
119 enum ndr_err_code err = ndr_pull_uint32(ndr, ndr_flags, &v32);
121 if (unlikely(v32 != *v)) {
122 DEBUG(0,(__location__ ": non-zero upper 16 bits 0x%08x\n", (unsigned)v32));
123 return NDR_ERR_NDR64;
127 return ndr_pull_uint16(ndr, ndr_flags, v);
133 _PUBLIC_ enum ndr_err_code ndr_pull_int32(struct ndr_pull *ndr, int ndr_flags, int32_t *v)
135 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
136 NDR_PULL_ALIGN(ndr, 4);
137 NDR_PULL_NEED_BYTES(ndr, 4);
138 *v = NDR_IVALS(ndr, ndr->offset);
140 return NDR_ERR_SUCCESS;
146 _PUBLIC_ enum ndr_err_code ndr_pull_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
148 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
149 NDR_PULL_ALIGN(ndr, 4);
150 NDR_PULL_NEED_BYTES(ndr, 4);
151 *v = NDR_IVAL(ndr, ndr->offset);
153 return NDR_ERR_SUCCESS;
157 parse a arch dependent uint32/uint64
159 _PUBLIC_ enum ndr_err_code ndr_pull_uint3264(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
162 enum ndr_err_code err;
163 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
164 if (likely(!(ndr->flags & LIBNDR_FLAG_NDR64))) {
165 return ndr_pull_uint32(ndr, ndr_flags, v);
167 err = ndr_pull_hyper(ndr, ndr_flags, &v64);
169 if (unlikely(v64 != *v)) {
170 DEBUG(0,(__location__ ": non-zero upper 32 bits 0x%016llx\n",
171 (unsigned long long)v64));
172 return NDR_ERR_NDR64;
180 _PUBLIC_ enum ndr_err_code ndr_pull_double(struct ndr_pull *ndr, int ndr_flags, double *v)
182 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
183 NDR_PULL_ALIGN(ndr, 8);
184 NDR_PULL_NEED_BYTES(ndr, 8);
185 memcpy(v, ndr->data+ndr->offset, 8);
187 return NDR_ERR_SUCCESS;
191 parse a pointer referent identifier stored in 2 bytes
193 _PUBLIC_ enum ndr_err_code ndr_pull_relative_ptr_short(struct ndr_pull *ndr, uint16_t *v)
195 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, v));
199 *(v) -= ndr->relative_rap_convert;
200 return NDR_ERR_SUCCESS;
204 parse a pointer referent identifier
206 _PUBLIC_ enum ndr_err_code ndr_pull_generic_ptr(struct ndr_pull *ndr, uint32_t *v)
208 NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, v));
212 return NDR_ERR_SUCCESS;
216 parse a ref pointer referent identifier
218 _PUBLIC_ enum ndr_err_code ndr_pull_ref_ptr(struct ndr_pull *ndr, uint32_t *v)
220 NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, v));
221 /* ref pointers always point to data */
223 return NDR_ERR_SUCCESS;
229 _PUBLIC_ enum ndr_err_code ndr_pull_udlong(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
231 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
232 NDR_PULL_ALIGN(ndr, 4);
233 NDR_PULL_NEED_BYTES(ndr, 8);
234 *v = NDR_IVAL(ndr, ndr->offset);
235 *v |= (uint64_t)(NDR_IVAL(ndr, ndr->offset+4)) << 32;
237 return NDR_ERR_SUCCESS;
243 _PUBLIC_ enum ndr_err_code ndr_pull_udlongr(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
245 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
246 NDR_PULL_ALIGN(ndr, 4);
247 NDR_PULL_NEED_BYTES(ndr, 8);
248 *v = ((uint64_t)NDR_IVAL(ndr, ndr->offset)) << 32;
249 *v |= NDR_IVAL(ndr, ndr->offset+4);
251 return NDR_ERR_SUCCESS;
257 _PUBLIC_ enum ndr_err_code ndr_pull_dlong(struct ndr_pull *ndr, int ndr_flags, int64_t *v)
259 return ndr_pull_udlong(ndr, ndr_flags, (uint64_t *)v);
265 _PUBLIC_ enum ndr_err_code ndr_pull_hyper(struct ndr_pull *ndr, int ndr_flags, uint64_t *v)
267 NDR_PULL_ALIGN(ndr, 8);
269 return ndr_pull_udlongr(ndr, ndr_flags, v);
271 return ndr_pull_udlong(ndr, ndr_flags, v);
277 _PUBLIC_ enum ndr_err_code ndr_pull_pointer(struct ndr_pull *ndr, int ndr_flags, void* *v)
280 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
281 NDR_PULL_ALIGN(ndr, sizeof(h));
282 NDR_PULL_NEED_BYTES(ndr, sizeof(h));
283 memcpy(&h, ndr->data+ndr->offset, sizeof(h));
284 ndr->offset += sizeof(h);
286 return NDR_ERR_SUCCESS;
292 _PUBLIC_ enum ndr_err_code ndr_pull_NTSTATUS(struct ndr_pull *ndr, int ndr_flags, NTSTATUS *status)
295 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
296 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
297 *status = NT_STATUS(v);
298 return NDR_ERR_SUCCESS;
304 _PUBLIC_ enum ndr_err_code ndr_push_NTSTATUS(struct ndr_push *ndr, int ndr_flags, NTSTATUS status)
306 return ndr_push_uint32(ndr, ndr_flags, NT_STATUS_V(status));
309 _PUBLIC_ void ndr_print_NTSTATUS(struct ndr_print *ndr, const char *name, NTSTATUS r)
311 ndr->print(ndr, "%-25s: %s", name, nt_errstr(r));
317 _PUBLIC_ enum ndr_err_code ndr_pull_WERROR(struct ndr_pull *ndr, int ndr_flags, WERROR *status)
320 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
321 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &v));
322 *status = W_ERROR(v);
323 return NDR_ERR_SUCCESS;
330 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *v)
332 return ndr_pull_uint8(ndr, ndr_flags, v);
336 parse a uint16_t enum
338 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint16(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
340 return ndr_pull_uint16(ndr, ndr_flags, v);
344 parse a uint1632_t enum (uint32_t on NDR64)
346 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint1632(struct ndr_pull *ndr, int ndr_flags, uint16_t *v)
348 if (unlikely(ndr->flags & LIBNDR_FLAG_NDR64)) {
350 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &v32));
353 DEBUG(0,(__location__ ": non-zero upper 16 bits 0x%08x\n", (unsigned)v32));
354 return NDR_ERR_NDR64;
356 return NDR_ERR_SUCCESS;
358 return ndr_pull_uint16(ndr, ndr_flags, v);
362 parse a uint32_t enum
364 _PUBLIC_ enum ndr_err_code ndr_pull_enum_uint32(struct ndr_pull *ndr, int ndr_flags, uint32_t *v)
366 return ndr_pull_uint32(ndr, ndr_flags, v);
372 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
374 return ndr_push_uint8(ndr, ndr_flags, v);
380 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
382 return ndr_push_uint16(ndr, ndr_flags, v);
388 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
390 return ndr_push_uint32(ndr, ndr_flags, v);
394 push a uint1632_t enum
396 _PUBLIC_ enum ndr_err_code ndr_push_enum_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v)
398 if (unlikely(ndr->flags & LIBNDR_FLAG_NDR64)) {
399 return ndr_push_uint32(ndr, ndr_flags, v);
401 return ndr_push_uint16(ndr, ndr_flags, v);
407 _PUBLIC_ enum ndr_err_code ndr_push_WERROR(struct ndr_push *ndr, int ndr_flags, WERROR status)
409 return ndr_push_uint32(ndr, NDR_SCALARS, W_ERROR_V(status));
412 _PUBLIC_ void ndr_print_WERROR(struct ndr_print *ndr, const char *name, WERROR r)
414 ndr->print(ndr, "%-25s: %s", name, win_errstr(r));
420 _PUBLIC_ enum ndr_err_code ndr_pull_bytes(struct ndr_pull *ndr, uint8_t *data, uint32_t n)
422 NDR_PULL_NEED_BYTES(ndr, n);
423 memcpy(data, ndr->data + ndr->offset, n);
425 return NDR_ERR_SUCCESS;
429 pull an array of uint8
431 _PUBLIC_ enum ndr_err_code ndr_pull_array_uint8(struct ndr_pull *ndr, int ndr_flags, uint8_t *data, uint32_t n)
433 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
434 if (!(ndr_flags & NDR_SCALARS)) {
435 return NDR_ERR_SUCCESS;
437 return ndr_pull_bytes(ndr, data, n);
443 _PUBLIC_ enum ndr_err_code ndr_push_int8(struct ndr_push *ndr, int ndr_flags, int8_t v)
445 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
446 NDR_PUSH_NEED_BYTES(ndr, 1);
447 SCVAL(ndr->data, ndr->offset, (uint8_t)v);
449 return NDR_ERR_SUCCESS;
455 _PUBLIC_ enum ndr_err_code ndr_push_uint8(struct ndr_push *ndr, int ndr_flags, uint8_t v)
457 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
458 NDR_PUSH_NEED_BYTES(ndr, 1);
459 SCVAL(ndr->data, ndr->offset, v);
461 return NDR_ERR_SUCCESS;
467 _PUBLIC_ enum ndr_err_code ndr_push_int16(struct ndr_push *ndr, int ndr_flags, int16_t v)
469 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
470 NDR_PUSH_ALIGN(ndr, 2);
471 NDR_PUSH_NEED_BYTES(ndr, 2);
472 NDR_SSVAL(ndr, ndr->offset, (uint16_t)v);
474 return NDR_ERR_SUCCESS;
480 _PUBLIC_ enum ndr_err_code ndr_push_uint16(struct ndr_push *ndr, int ndr_flags, uint16_t v)
482 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
483 NDR_PUSH_ALIGN(ndr, 2);
484 NDR_PUSH_NEED_BYTES(ndr, 2);
485 NDR_SSVAL(ndr, ndr->offset, v);
487 return NDR_ERR_SUCCESS;
493 _PUBLIC_ enum ndr_err_code ndr_push_uint1632(struct ndr_push *ndr, int ndr_flags, uint16_t v)
495 if (unlikely(ndr->flags & LIBNDR_FLAG_NDR64)) {
496 return ndr_push_uint32(ndr, ndr_flags, v);
498 return ndr_push_uint16(ndr, ndr_flags, v);
504 _PUBLIC_ enum ndr_err_code ndr_push_int32(struct ndr_push *ndr, int ndr_flags, int32_t v)
506 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
507 NDR_PUSH_ALIGN(ndr, 4);
508 NDR_PUSH_NEED_BYTES(ndr, 4);
509 NDR_SIVALS(ndr, ndr->offset, v);
511 return NDR_ERR_SUCCESS;
517 _PUBLIC_ enum ndr_err_code ndr_push_uint32(struct ndr_push *ndr, int ndr_flags, uint32_t v)
519 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
520 NDR_PUSH_ALIGN(ndr, 4);
521 NDR_PUSH_NEED_BYTES(ndr, 4);
522 NDR_SIVAL(ndr, ndr->offset, v);
524 return NDR_ERR_SUCCESS;
530 _PUBLIC_ enum ndr_err_code ndr_push_uint3264(struct ndr_push *ndr, int ndr_flags, uint32_t v)
532 if (unlikely(ndr->flags & LIBNDR_FLAG_NDR64)) {
533 return ndr_push_hyper(ndr, ndr_flags, v);
535 return ndr_push_uint32(ndr, ndr_flags, v);
541 _PUBLIC_ enum ndr_err_code ndr_push_udlong(struct ndr_push *ndr, int ndr_flags, uint64_t v)
543 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
544 NDR_PUSH_ALIGN(ndr, 4);
545 NDR_PUSH_NEED_BYTES(ndr, 8);
546 NDR_SIVAL(ndr, ndr->offset, (v & 0xFFFFFFFF));
547 NDR_SIVAL(ndr, ndr->offset+4, (v>>32));
549 return NDR_ERR_SUCCESS;
555 _PUBLIC_ enum ndr_err_code ndr_push_udlongr(struct ndr_push *ndr, int ndr_flags, uint64_t v)
557 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
558 NDR_PUSH_ALIGN(ndr, 4);
559 NDR_PUSH_NEED_BYTES(ndr, 8);
560 NDR_SIVAL(ndr, ndr->offset, (v>>32));
561 NDR_SIVAL(ndr, ndr->offset+4, (v & 0xFFFFFFFF));
563 return NDR_ERR_SUCCESS;
569 _PUBLIC_ enum ndr_err_code ndr_push_dlong(struct ndr_push *ndr, int ndr_flags, int64_t v)
571 return ndr_push_udlong(ndr, NDR_SCALARS, (uint64_t)v);
577 _PUBLIC_ enum ndr_err_code ndr_push_hyper(struct ndr_push *ndr, int ndr_flags, uint64_t v)
579 NDR_PUSH_ALIGN(ndr, 8);
581 return ndr_push_udlongr(ndr, NDR_SCALARS, v);
583 return ndr_push_udlong(ndr, NDR_SCALARS, v);
589 _PUBLIC_ enum ndr_err_code ndr_push_double(struct ndr_push *ndr, int ndr_flags, double v)
591 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
592 NDR_PUSH_ALIGN(ndr, 8);
593 NDR_PUSH_NEED_BYTES(ndr, 8);
594 memcpy(ndr->data+ndr->offset, &v, 8);
596 return NDR_ERR_SUCCESS;
602 _PUBLIC_ enum ndr_err_code ndr_push_pointer(struct ndr_push *ndr, int ndr_flags, void* v)
604 uintptr_t h = (intptr_t)v;
605 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
606 NDR_PUSH_ALIGN(ndr, sizeof(h));
607 NDR_PUSH_NEED_BYTES(ndr, sizeof(h));
608 memcpy(ndr->data+ndr->offset, &h, sizeof(h));
609 ndr->offset += sizeof(h);
610 return NDR_ERR_SUCCESS;
613 _PUBLIC_ enum ndr_err_code ndr_push_align(struct ndr_push *ndr, size_t size)
615 /* this is a nasty hack to make pidl work with NDR64 */
617 if (ndr->flags & LIBNDR_FLAG_NDR64) {
622 } else if (size == 3) {
623 if (ndr->flags & LIBNDR_FLAG_NDR64) {
629 NDR_PUSH_ALIGN(ndr, size);
630 return NDR_ERR_SUCCESS;
633 _PUBLIC_ enum ndr_err_code ndr_pull_align(struct ndr_pull *ndr, size_t size)
635 /* this is a nasty hack to make pidl work with NDR64 */
637 if (ndr->flags & LIBNDR_FLAG_NDR64) {
642 } else if (size == 3) {
643 if (ndr->flags & LIBNDR_FLAG_NDR64) {
649 NDR_PULL_ALIGN(ndr, size);
650 return NDR_ERR_SUCCESS;
653 _PUBLIC_ enum ndr_err_code ndr_push_union_align(struct ndr_push *ndr, size_t size)
655 /* MS-RPCE section 2.2.5.3.4.4 */
656 if (ndr->flags & LIBNDR_FLAG_NDR64) {
657 return ndr_push_align(ndr, size);
659 return NDR_ERR_SUCCESS;
662 _PUBLIC_ enum ndr_err_code ndr_pull_union_align(struct ndr_pull *ndr, size_t size)
664 /* MS-RPCE section 2.2.5.3.4.4 */
665 if (ndr->flags & LIBNDR_FLAG_NDR64) {
666 return ndr_pull_align(ndr, size);
668 return NDR_ERR_SUCCESS;
671 _PUBLIC_ enum ndr_err_code ndr_push_trailer_align(struct ndr_push *ndr, size_t size)
673 /* MS-RPCE section 2.2.5.3.4.1 */
674 if (ndr->flags & LIBNDR_FLAG_NDR64) {
675 return ndr_push_align(ndr, size);
677 return NDR_ERR_SUCCESS;
680 _PUBLIC_ enum ndr_err_code ndr_pull_trailer_align(struct ndr_pull *ndr, size_t size)
682 /* MS-RPCE section 2.2.5.3.4.1 */
683 if (ndr->flags & LIBNDR_FLAG_NDR64) {
684 return ndr_pull_align(ndr, size);
686 return NDR_ERR_SUCCESS;
692 _PUBLIC_ enum ndr_err_code ndr_push_bytes(struct ndr_push *ndr, const uint8_t *data, uint32_t n)
694 NDR_PUSH_NEED_BYTES(ndr, n);
695 memcpy(ndr->data + ndr->offset, data, n);
697 return NDR_ERR_SUCCESS;
703 _PUBLIC_ enum ndr_err_code ndr_push_zero(struct ndr_push *ndr, uint32_t n)
705 NDR_PUSH_NEED_BYTES(ndr, n);
706 memset(ndr->data + ndr->offset, 0, n);
708 return NDR_ERR_SUCCESS;
712 push an array of uint8
714 _PUBLIC_ enum ndr_err_code ndr_push_array_uint8(struct ndr_push *ndr, int ndr_flags, const uint8_t *data, uint32_t n)
716 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
717 if (!(ndr_flags & NDR_SCALARS)) {
718 return NDR_ERR_SUCCESS;
720 return ndr_push_bytes(ndr, data, n);
724 push a unique non-zero value if a pointer is non-NULL, otherwise 0
726 _PUBLIC_ enum ndr_err_code ndr_push_unique_ptr(struct ndr_push *ndr, const void *p)
730 ptr = ndr->ptr_count * 4;
734 return ndr_push_uint3264(ndr, NDR_SCALARS, ptr);
738 push a 'simple' full non-zero value if a pointer is non-NULL, otherwise 0
740 _PUBLIC_ enum ndr_err_code ndr_push_full_ptr(struct ndr_push *ndr, const void *p)
744 /* Check if the pointer already exists and has an id */
745 ptr = ndr_token_peek(&ndr->full_ptr_list, p);
748 ptr = ndr->ptr_count;
749 ndr_token_store(ndr, &ndr->full_ptr_list, p, ptr);
752 return ndr_push_uint3264(ndr, NDR_SCALARS, ptr);
756 push always a 0, if a pointer is NULL it's a fatal error
758 _PUBLIC_ enum ndr_err_code ndr_push_ref_ptr(struct ndr_push *ndr)
760 return ndr_push_uint3264(ndr, NDR_SCALARS, 0xAEF1AEF1);
767 _PUBLIC_ enum ndr_err_code ndr_push_NTTIME(struct ndr_push *ndr, int ndr_flags, NTTIME t)
769 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
770 NDR_CHECK(ndr_push_udlong(ndr, ndr_flags, t));
771 return NDR_ERR_SUCCESS;
777 _PUBLIC_ enum ndr_err_code ndr_pull_NTTIME(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
779 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
780 NDR_CHECK(ndr_pull_udlong(ndr, ndr_flags, t));
781 return NDR_ERR_SUCCESS;
787 _PUBLIC_ enum ndr_err_code ndr_push_NTTIME_1sec(struct ndr_push *ndr, int ndr_flags, NTTIME t)
789 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
791 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
792 return NDR_ERR_SUCCESS;
798 _PUBLIC_ enum ndr_err_code ndr_pull_NTTIME_1sec(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
800 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
801 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
803 return NDR_ERR_SUCCESS;
809 _PUBLIC_ enum ndr_err_code ndr_pull_NTTIME_hyper(struct ndr_pull *ndr, int ndr_flags, NTTIME *t)
811 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
812 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, t));
813 return NDR_ERR_SUCCESS;
819 _PUBLIC_ enum ndr_err_code ndr_push_NTTIME_hyper(struct ndr_push *ndr, int ndr_flags, NTTIME t)
821 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
822 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t));
823 return NDR_ERR_SUCCESS;
829 _PUBLIC_ enum ndr_err_code ndr_push_time_t(struct ndr_push *ndr, int ndr_flags, time_t t)
831 return ndr_push_uint32(ndr, ndr_flags, t);
837 _PUBLIC_ enum ndr_err_code ndr_pull_time_t(struct ndr_pull *ndr, int ndr_flags, time_t *t)
840 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &tt));
842 return NDR_ERR_SUCCESS;
849 _PUBLIC_ enum ndr_err_code ndr_push_uid_t(struct ndr_push *ndr, int ndr_flags, uid_t u)
851 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
852 return ndr_push_hyper(ndr, NDR_SCALARS, (uint64_t)u);
858 _PUBLIC_ enum ndr_err_code ndr_pull_uid_t(struct ndr_pull *ndr, int ndr_flags, uid_t *u)
861 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, &uu));
863 if (unlikely(uu != *u)) {
864 DEBUG(0,(__location__ ": uid_t pull doesn't fit 0x%016llx\n",
865 (unsigned long long)uu));
866 return NDR_ERR_NDR64;
868 return NDR_ERR_SUCCESS;
875 _PUBLIC_ enum ndr_err_code ndr_push_gid_t(struct ndr_push *ndr, int ndr_flags, gid_t g)
877 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
878 return ndr_push_hyper(ndr, NDR_SCALARS, (uint64_t)g);
884 _PUBLIC_ enum ndr_err_code ndr_pull_gid_t(struct ndr_pull *ndr, int ndr_flags, gid_t *g)
887 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, &gg));
889 if (unlikely(gg != *g)) {
890 DEBUG(0,(__location__ ": gid_t pull doesn't fit 0x%016llx\n",
891 (unsigned long long)gg));
892 return NDR_ERR_NDR64;
894 return NDR_ERR_SUCCESS;
901 _PUBLIC_ enum ndr_err_code ndr_pull_ipv4address(struct ndr_pull *ndr, int ndr_flags, const char **address)
905 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &addr));
906 in.s_addr = htonl(addr);
907 *address = talloc_strdup(ndr->current_mem_ctx, inet_ntoa(in));
908 NDR_ERR_HAVE_NO_MEMORY(*address);
909 return NDR_ERR_SUCCESS;
915 _PUBLIC_ enum ndr_err_code ndr_push_ipv4address(struct ndr_push *ndr, int ndr_flags, const char *address)
918 if (!is_ipaddress(address)) {
919 return ndr_push_error(ndr, NDR_ERR_IPV4ADDRESS,
920 "Invalid IPv4 address: '%s'",
923 addr = inet_addr(address);
924 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, htonl(addr)));
925 return NDR_ERR_SUCCESS;
931 _PUBLIC_ void ndr_print_ipv4address(struct ndr_print *ndr, const char *name,
934 ndr->print(ndr, "%-25s: %s", name, address);
940 #define IPV6_BYTES 16
941 #define IPV6_ADDR_STR_LEN 39
942 _PUBLIC_ enum ndr_err_code ndr_pull_ipv6address(struct ndr_pull *ndr, int ndr_flags, const char **address)
944 uint8_t addr[IPV6_BYTES];
945 char *addr_str = talloc_strdup(ndr->current_mem_ctx, "");
947 NDR_CHECK(ndr_pull_array_uint8(ndr, ndr_flags, addr, IPV6_BYTES));
948 for (i = 0; i < IPV6_BYTES; ++i) {
949 addr_str = talloc_asprintf_append(addr_str, "%02x", addr[i]);
950 /* We need a ':' every second byte but the last one */
951 if (i%2 == 1 && i != (IPV6_BYTES - 1)) {
952 addr_str = talloc_strdup_append(addr_str, ":");
956 NDR_ERR_HAVE_NO_MEMORY(*address);
957 return NDR_ERR_SUCCESS;
963 _PUBLIC_ enum ndr_err_code ndr_push_ipv6address(struct ndr_push *ndr, int ndr_flags, const char *address)
966 uint8_t addr[IPV6_BYTES];
969 if (!is_ipaddress(address)) {
970 return ndr_push_error(ndr, NDR_ERR_IPV6ADDRESS,
971 "Invalid IPv6 address: '%s'",
974 ret = inet_pton(AF_INET6, address, addr);
976 return NDR_ERR_IPV6ADDRESS;
979 NDR_CHECK(ndr_push_array_uint8(ndr, ndr_flags, addr, IPV6_BYTES));
981 return NDR_ERR_SUCCESS;
983 return NDR_ERR_IPV6ADDRESS;
990 _PUBLIC_ void ndr_print_ipv6address(struct ndr_print *ndr, const char *name,
993 ndr->print(ndr, "%-25s: %s", name, address);
997 _PUBLIC_ void ndr_print_struct(struct ndr_print *ndr, const char *name, const char *type)
999 ndr->print(ndr, "%s: struct %s", name, type);
1002 _PUBLIC_ void ndr_print_null(struct ndr_print *ndr)
1004 ndr->print(ndr, "UNEXPECTED NULL POINTER");
1007 _PUBLIC_ void ndr_print_enum(struct ndr_print *ndr, const char *name, const char *type,
1008 const char *val, uint32_t value)
1010 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
1011 ndr->print(ndr, "%-25s: %s (0x%X)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
1013 ndr->print(ndr, "%-25s: %s (%d)", name, val?val:"UNKNOWN_ENUM_VALUE", value);
1017 _PUBLIC_ void ndr_print_bitmap_flag(struct ndr_print *ndr, size_t size, const char *flag_name, uint32_t flag, uint32_t value)
1019 /* this is an attempt to support multi-bit bitmap masks */
1022 while (!(flag & 1)) {
1027 ndr->print(ndr, " %d: %-25s", value, flag_name);
1029 ndr->print(ndr, "0x%02x: %-25s (%d)", value, flag_name, value);
1033 _PUBLIC_ void ndr_print_int8(struct ndr_print *ndr, const char *name, int8_t v)
1035 ndr->print(ndr, "%-25s: %d", name, v);
1038 _PUBLIC_ void ndr_print_uint8(struct ndr_print *ndr, const char *name, uint8_t v)
1040 ndr->print(ndr, "%-25s: 0x%02x (%u)", name, v, v);
1043 _PUBLIC_ void ndr_print_int16(struct ndr_print *ndr, const char *name, int16_t v)
1045 ndr->print(ndr, "%-25s: %d", name, v);
1048 _PUBLIC_ void ndr_print_uint16(struct ndr_print *ndr, const char *name, uint16_t v)
1050 ndr->print(ndr, "%-25s: 0x%04x (%u)", name, v, v);
1053 _PUBLIC_ void ndr_print_int32(struct ndr_print *ndr, const char *name, int32_t v)
1055 ndr->print(ndr, "%-25s: %d", name, v);
1058 _PUBLIC_ void ndr_print_uint32(struct ndr_print *ndr, const char *name, uint32_t v)
1060 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
1063 _PUBLIC_ void ndr_print_int3264(struct ndr_print *ndr, const char *name, int32_t v)
1065 ndr->print(ndr, "%-25s: %d", name, v);
1068 _PUBLIC_ void ndr_print_uint3264(struct ndr_print *ndr, const char *name, uint32_t v)
1070 ndr->print(ndr, "%-25s: 0x%08x (%u)", name, v, v);
1073 _PUBLIC_ void ndr_print_udlong(struct ndr_print *ndr, const char *name, uint64_t v)
1075 ndr->print(ndr, "%-25s: 0x%016llx (%llu)", name, (unsigned long long)v, (unsigned long long)v);
1078 _PUBLIC_ void ndr_print_udlongr(struct ndr_print *ndr, const char *name, uint64_t v)
1080 ndr_print_udlong(ndr, name, v);
1083 _PUBLIC_ void ndr_print_dlong(struct ndr_print *ndr, const char *name, int64_t v)
1085 ndr->print(ndr, "%-25s: 0x%016llx (%lld)", name, (unsigned long long)v, (long long)v);
1088 _PUBLIC_ void ndr_print_double(struct ndr_print *ndr, const char *name, double v)
1090 ndr->print(ndr, "%-25s: %f", name, v);
1093 _PUBLIC_ void ndr_print_hyper(struct ndr_print *ndr, const char *name, uint64_t v)
1095 ndr_print_dlong(ndr, name, v);
1098 _PUBLIC_ void ndr_print_pointer(struct ndr_print *ndr, const char *name, void *v)
1100 ndr->print(ndr, "%-25s: %p", name, v);
1103 _PUBLIC_ void ndr_print_ptr(struct ndr_print *ndr, const char *name, const void *p)
1106 ndr->print(ndr, "%-25s: *", name);
1108 ndr->print(ndr, "%-25s: NULL", name);
1112 _PUBLIC_ void ndr_print_NTTIME(struct ndr_print *ndr, const char *name, NTTIME t)
1114 ndr->print(ndr, "%-25s: %s", name, nt_time_string(ndr, t));
1117 _PUBLIC_ void ndr_print_NTTIME_1sec(struct ndr_print *ndr, const char *name, NTTIME t)
1119 /* this is a standard NTTIME here
1120 * as it's already converted in the pull/push code
1122 ndr_print_NTTIME(ndr, name, t);
1125 _PUBLIC_ void ndr_print_NTTIME_hyper(struct ndr_print *ndr, const char *name, NTTIME t)
1127 ndr_print_NTTIME(ndr, name, t);
1130 _PUBLIC_ void ndr_print_time_t(struct ndr_print *ndr, const char *name, time_t t)
1132 if (t == (time_t)-1 || t == 0) {
1133 ndr->print(ndr, "%-25s: (time_t)%d", name, (int)t);
1135 ndr->print(ndr, "%-25s: %s", name, timestring(ndr, t));
1139 _PUBLIC_ void ndr_print_uid_t(struct ndr_print *ndr, const char *name, uid_t u)
1141 ndr_print_dlong(ndr, name, u);
1144 _PUBLIC_ void ndr_print_gid_t(struct ndr_print *ndr, const char *name, gid_t g)
1146 ndr_print_dlong(ndr, name, g);
1149 _PUBLIC_ void ndr_print_union(struct ndr_print *ndr, const char *name, int level, const char *type)
1151 if (ndr->flags & LIBNDR_PRINT_ARRAY_HEX) {
1152 ndr->print(ndr, "%-25s: union %s(case 0x%X)", name, type, level);
1154 ndr->print(ndr, "%-25s: union %s(case %d)", name, type, level);
1158 _PUBLIC_ void ndr_print_bad_level(struct ndr_print *ndr, const char *name, uint16_t level)
1160 ndr->print(ndr, "UNKNOWN LEVEL %u", level);
1163 _PUBLIC_ void ndr_print_array_uint8(struct ndr_print *ndr, const char *name,
1164 const uint8_t *data, uint32_t count)
1167 #define _ONELINE_LIMIT 32
1170 ndr->print(ndr, "%s: ARRAY(%d) : NULL", name, count);
1174 if (count <= _ONELINE_LIMIT && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
1175 char s[(_ONELINE_LIMIT + 1) * 2];
1176 for (i=0;i<count;i++) {
1177 snprintf(&s[i*2], 3, "%02x", data[i]);
1180 ndr->print(ndr, "%-25s: %s", name, s);
1184 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
1185 if (count > _ONELINE_LIMIT && (ndr->flags & LIBNDR_PRINT_ARRAY_HEX)) {
1186 ndr_dump_data(ndr, data, count);
1191 for (i=0;i<count;i++) {
1193 if (asprintf(&idx, "[%d]", i) != -1) {
1194 ndr_print_uint8(ndr, idx, data[i]);
1199 #undef _ONELINE_LIMIT
1202 static void ndr_print_asc(struct ndr_print *ndr, const uint8_t *buf, int len)
1206 ndr->print(ndr, "%c", isprint(buf[i])?buf[i]:'.');
1210 ndr_print version of dump_data()
1212 static void ndr_dump_data(struct ndr_print *ndr, const uint8_t *buf, int len)
1216 ndr->no_newline = true;
1219 if (i%16 == 0 && i<len) {
1220 ndr->print(ndr, "[%04X] ",i);
1223 ndr->print(ndr, "%02X ",(int)buf[i]);
1225 if (i%8 == 0) ndr->print(ndr," ");
1227 ndr_print_asc(ndr,&buf[i-16],8); ndr->print(ndr," ");
1228 ndr_print_asc(ndr,&buf[i-8],8); ndr->print(ndr, "\n");
1235 ndr->print(ndr, " ");
1236 if (n>8) ndr->print(ndr," ");
1237 while (n--) ndr->print(ndr," ");
1239 ndr_print_asc(ndr,&buf[i-(i%16)],n); ndr->print(ndr, " ");
1241 if (n>0) ndr_print_asc(ndr,&buf[i-n],n);
1242 ndr->print(ndr,"\n");
1245 ndr->no_newline = false;
1249 _PUBLIC_ void ndr_print_DATA_BLOB(struct ndr_print *ndr, const char *name, DATA_BLOB r)
1251 ndr->print(ndr, "%-25s: DATA_BLOB length=%u", name, (unsigned)r.length);
1253 ndr_dump_data(ndr, r.data, r.length);
1259 * Push a DATA_BLOB onto the wire.
1260 * 1) When called with LIBNDR_FLAG_ALIGN* alignment flags set, push padding
1261 * bytes _only_. The length is determined by the alignment required and the
1262 * current ndr offset.
1263 * 2) When called with the LIBNDR_FLAG_REMAINING flag, push the byte array to
1265 * 3) Otherwise, push a uint3264 length _and_ a corresponding byte array to the
1268 _PUBLIC_ enum ndr_err_code ndr_push_DATA_BLOB(struct ndr_push *ndr, int ndr_flags, DATA_BLOB blob)
1270 if (ndr->flags & LIBNDR_FLAG_REMAINING) {
1272 } else if (ndr->flags & (LIBNDR_ALIGN_FLAGS & ~LIBNDR_FLAG_NOALIGN)) {
1273 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
1274 blob.length = NDR_ALIGN(ndr, 2);
1275 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
1276 blob.length = NDR_ALIGN(ndr, 4);
1277 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
1278 blob.length = NDR_ALIGN(ndr, 8);
1280 NDR_PUSH_ALLOC_SIZE(ndr, blob.data, blob.length);
1281 data_blob_clear(&blob);
1283 NDR_CHECK(ndr_push_uint3264(ndr, NDR_SCALARS, blob.length));
1285 NDR_CHECK(ndr_push_bytes(ndr, blob.data, blob.length));
1286 return NDR_ERR_SUCCESS;
1290 * Pull a DATA_BLOB from the wire.
1291 * 1) when called with LIBNDR_FLAG_ALIGN* alignment flags set, pull padding
1292 * bytes _only_. The length is determined by the alignment required and the
1293 * current ndr offset.
1294 * 2) When called with the LIBNDR_FLAG_REMAINING flag, pull all remaining bytes
1295 * from the ndr buffer.
1296 * 3) Otherwise, pull a uint3264 length _and_ a corresponding byte array from the
1299 _PUBLIC_ enum ndr_err_code ndr_pull_DATA_BLOB(struct ndr_pull *ndr, int ndr_flags, DATA_BLOB *blob)
1301 uint32_t length = 0;
1303 if (ndr->flags & LIBNDR_FLAG_REMAINING) {
1304 length = ndr->data_size - ndr->offset;
1305 } else if (ndr->flags & (LIBNDR_ALIGN_FLAGS & ~LIBNDR_FLAG_NOALIGN)) {
1306 if (ndr->flags & LIBNDR_FLAG_ALIGN2) {
1307 length = NDR_ALIGN(ndr, 2);
1308 } else if (ndr->flags & LIBNDR_FLAG_ALIGN4) {
1309 length = NDR_ALIGN(ndr, 4);
1310 } else if (ndr->flags & LIBNDR_FLAG_ALIGN8) {
1311 length = NDR_ALIGN(ndr, 8);
1313 if (ndr->data_size - ndr->offset < length) {
1314 length = ndr->data_size - ndr->offset;
1317 NDR_CHECK(ndr_pull_uint3264(ndr, NDR_SCALARS, &length));
1319 NDR_PULL_NEED_BYTES(ndr, length);
1320 *blob = data_blob_talloc(ndr->current_mem_ctx, ndr->data+ndr->offset, length);
1321 ndr->offset += length;
1322 return NDR_ERR_SUCCESS;
1325 _PUBLIC_ uint32_t ndr_size_DATA_BLOB(int ret, const DATA_BLOB *data, int flags)
1327 if (!data) return ret;
1328 return ret + data->length;
1331 _PUBLIC_ void ndr_print_bool(struct ndr_print *ndr, const char *name, const bool b)
1333 ndr->print(ndr, "%-25s: %s", name, b?"true":"false");
1336 _PUBLIC_ NTSTATUS ndr_map_error2ntstatus(enum ndr_err_code ndr_err)
1339 case NDR_ERR_SUCCESS:
1340 return NT_STATUS_OK;
1341 case NDR_ERR_BUFSIZE:
1342 return NT_STATUS_BUFFER_TOO_SMALL;
1344 return NT_STATUS_INTERNAL_ERROR;
1346 return NT_STATUS_NO_MEMORY;
1347 case NDR_ERR_ARRAY_SIZE:
1348 return NT_STATUS_ARRAY_BOUNDS_EXCEEDED;
1349 case NDR_ERR_INVALID_POINTER:
1350 return NT_STATUS_INVALID_PARAMETER_MIX;
1351 case NDR_ERR_UNREAD_BYTES:
1352 return NT_STATUS_PORT_MESSAGE_TOO_LONG;
1357 /* we should map all error codes to different status codes */
1358 return NT_STATUS_INVALID_PARAMETER;
1361 _PUBLIC_ int ndr_map_error2errno(enum ndr_err_code ndr_err)
1364 case NDR_ERR_SUCCESS:
1366 case NDR_ERR_BUFSIZE:
1372 case NDR_ERR_ARRAY_SIZE:
1374 case NDR_ERR_INVALID_POINTER:
1376 case NDR_ERR_UNREAD_BYTES:
1382 /* we should map all error codes to different status codes */
1386 _PUBLIC_ enum ndr_err_code ndr_push_timespec(struct ndr_push *ndr,
1388 const struct timespec *t)
1390 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
1391 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t->tv_sec));
1392 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, t->tv_nsec));
1393 return NDR_ERR_SUCCESS;
1396 _PUBLIC_ enum ndr_err_code ndr_pull_timespec(struct ndr_pull *ndr,
1402 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
1403 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, &secs));
1404 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &nsecs));
1407 return NDR_ERR_SUCCESS;
1410 _PUBLIC_ void ndr_print_timespec(struct ndr_print *ndr, const char *name,
1411 const struct timespec *t)
1413 ndr->print(ndr, "%-25s: %s.%ld", name, timestring(ndr, t->tv_sec),
1417 _PUBLIC_ enum ndr_err_code ndr_push_timeval(struct ndr_push *ndr,
1419 const struct timeval *t)
1421 NDR_PUSH_CHECK_FLAGS(ndr, ndr_flags);
1422 NDR_CHECK(ndr_push_hyper(ndr, ndr_flags, t->tv_sec));
1423 NDR_CHECK(ndr_push_uint32(ndr, ndr_flags, t->tv_usec));
1424 return NDR_ERR_SUCCESS;
1427 _PUBLIC_ enum ndr_err_code ndr_pull_timeval(struct ndr_pull *ndr,
1433 NDR_PULL_CHECK_FLAGS(ndr, ndr_flags);
1434 NDR_CHECK(ndr_pull_hyper(ndr, ndr_flags, &secs));
1435 NDR_CHECK(ndr_pull_uint32(ndr, ndr_flags, &usecs));
1438 return NDR_ERR_SUCCESS;
1441 _PUBLIC_ void ndr_print_timeval(struct ndr_print *ndr, const char *name,
1442 const struct timeval *t)
1444 ndr->print(ndr, "%-25s: %s.%ld", name, timestring(ndr, t->tv_sec),