2 Unix SMB/CIFS implementation.
4 TDR (Trivial Data Representation) helper functions
5 Based loosely on ndr.c by Andrew Tridgell.
7 Copyright (C) Jelmer Vernooij 2005
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "system/network.h"
26 #include "system/filesys.h"
28 #define TDR_BASE_MARSHALL_SIZE 1024
30 #define TDR_PUSH_NEED_BYTES(tdr, n) TDR_CHECK(tdr_push_expand(tdr, tdr->data.length+(n)))
32 #define TDR_PULL_NEED_BYTES(tdr, n) do { \
33 if ((n) > tdr->data.length || tdr->offset + (n) > tdr->data.length) { \
34 return NT_STATUS_BUFFER_TOO_SMALL; \
38 #define TDR_BE(tdr) ((tdr)->flags & TDR_BIG_ENDIAN)
40 #define TDR_CVAL(tdr, ofs) CVAL(tdr->data.data,ofs)
41 #define TDR_SVAL(tdr, ofs) (TDR_BE(tdr)?RSVAL(tdr->data.data,ofs):SVAL(tdr->data.data,ofs))
42 #define TDR_IVAL(tdr, ofs) (TDR_BE(tdr)?RIVAL(tdr->data.data,ofs):IVAL(tdr->data.data,ofs))
43 #define TDR_IVALS(tdr, ofs) (TDR_BE(tdr)?RIVALS(tdr->data.data,ofs):IVALS(tdr->data.data,ofs))
44 #define TDR_SCVAL(tdr, ofs, v) SCVAL(tdr->data.data,ofs,v)
45 #define TDR_SSVAL(tdr, ofs, v) do { if (TDR_BE(tdr)) { RSSVAL(tdr->data.data,ofs,v); } else SSVAL(tdr->data.data,ofs,v); } while (0)
46 #define TDR_SIVAL(tdr, ofs, v) do { if (TDR_BE(tdr)) { RSIVAL(tdr->data.data,ofs,v); } else SIVAL(tdr->data.data,ofs,v); } while (0)
47 #define TDR_SIVALS(tdr, ofs, v) do { if (TDR_BE(tdr)) { RSIVALS(tdr->data.data,ofs,v); } else SIVALS(tdr->data.data,ofs,v); } while (0)
50 expand the available space in the buffer to 'size'
52 NTSTATUS
tdr_push_expand(struct tdr_push
*tdr
, uint32_t size
)
54 if (talloc_get_size(tdr
->data
.data
) >= size
) {
58 tdr
->data
.data
= talloc_realloc(tdr
, tdr
->data
.data
, uint8_t, tdr
->data
.length
+ TDR_BASE_MARSHALL_SIZE
);
60 if (tdr
->data
.data
== NULL
)
61 return NT_STATUS_NO_MEMORY
;
67 NTSTATUS
tdr_pull_uint8(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, uint8_t *v
)
69 TDR_PULL_NEED_BYTES(tdr
, 1);
70 *v
= TDR_CVAL(tdr
, tdr
->offset
);
75 NTSTATUS
tdr_push_uint8(struct tdr_push
*tdr
, const uint8_t *v
)
77 TDR_PUSH_NEED_BYTES(tdr
, 1);
78 TDR_SCVAL(tdr
, tdr
->data
.length
, *v
);
79 tdr
->data
.length
+= 1;
83 NTSTATUS
tdr_print_uint8(struct tdr_print
*tdr
, const char *name
, uint8_t *v
)
85 tdr
->print(tdr
, "%-25s: 0x%02x (%u)", name
, *v
, *v
);
89 NTSTATUS
tdr_pull_uint16(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, uint16_t *v
)
91 TDR_PULL_NEED_BYTES(tdr
, 2);
92 *v
= TDR_SVAL(tdr
, tdr
->offset
);
97 NTSTATUS
tdr_push_uint16(struct tdr_push
*tdr
, const uint16_t *v
)
99 TDR_PUSH_NEED_BYTES(tdr
, 2);
100 TDR_SSVAL(tdr
, tdr
->data
.length
, *v
);
101 tdr
->data
.length
+= 2;
105 NTSTATUS
tdr_print_uint16(struct tdr_print
*tdr
, const char *name
, uint16_t *v
)
107 tdr
->print(tdr
, "%-25s: 0x%02x (%u)", name
, *v
, *v
);
111 NTSTATUS
tdr_pull_uint32(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, uint32_t *v
)
113 TDR_PULL_NEED_BYTES(tdr
, 4);
114 *v
= TDR_IVAL(tdr
, tdr
->offset
);
119 NTSTATUS
tdr_push_uint32(struct tdr_push
*tdr
, const uint32_t *v
)
121 TDR_PUSH_NEED_BYTES(tdr
, 4);
122 TDR_SIVAL(tdr
, tdr
->data
.length
, *v
);
123 tdr
->data
.length
+= 4;
127 NTSTATUS
tdr_print_uint32(struct tdr_print
*tdr
, const char *name
, uint32_t *v
)
129 tdr
->print(tdr
, "%-25s: 0x%02x (%u)", name
, *v
, *v
);
133 NTSTATUS
tdr_pull_charset(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, const char **v
, uint32_t length
, uint32_t el_size
, int chset
)
140 length
= ascii_len_n((const char*)tdr
->data
.data
+tdr
->offset
, tdr
->data
.length
-tdr
->offset
);
143 length
= utf16_len_n(tdr
->data
.data
+tdr
->offset
, tdr
->data
.length
-tdr
->offset
);
147 return NT_STATUS_INVALID_PARAMETER
;
152 *v
= talloc_strdup(ctx
, "");
156 TDR_PULL_NEED_BYTES(tdr
, el_size
*length
);
158 ret
= convert_string_talloc(ctx
, chset
, CH_UNIX
, tdr
->data
.data
+tdr
->offset
, el_size
*length
, discard_const_p(void *, v
));
161 return NT_STATUS_INVALID_PARAMETER
;
164 tdr
->offset
+= length
* el_size
;
169 NTSTATUS
tdr_push_charset(struct tdr_push
*tdr
, const char **v
, uint32_t length
, uint32_t el_size
, int chset
)
171 ssize_t ret
, required
;
174 length
= strlen(*v
) + 1; /* Extra element for null character */
177 required
= el_size
* length
;
178 TDR_PUSH_NEED_BYTES(tdr
, required
);
180 ret
= convert_string(CH_UNIX
, chset
, *v
, strlen(*v
), tdr
->data
.data
+tdr
->data
.length
, required
);
183 return NT_STATUS_INVALID_PARAMETER
;
186 /* Make sure the remaining part of the string is filled with zeroes */
187 if (ret
< required
) {
188 memset(tdr
->data
.data
+tdr
->data
.length
+ret
, 0, required
-ret
);
191 tdr
->data
.length
+= required
;
196 NTSTATUS
tdr_print_charset(struct tdr_print
*tdr
, const char *name
, const char **v
, uint32_t length
, uint32_t el_size
, int chset
)
198 tdr
->print(tdr
, "%-25s: %s", name
, *v
);
205 NTSTATUS
tdr_pull_ipv4address(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, const char **address
)
208 TDR_CHECK(tdr_pull_uint32(tdr
, ctx
, &in
.addr
));
209 in
.addr
= htonl(in
.addr
);
210 *address
= talloc_strdup(tdr
, sys_inet_ntoa(in
));
211 NT_STATUS_HAVE_NO_MEMORY(*address
);
218 NTSTATUS
tdr_push_ipv4address(struct tdr_push
*tdr
, const char **address
)
220 uint32_t addr
= htonl(interpret_addr(*address
));
221 TDR_CHECK(tdr_push_uint32(tdr
, &addr
));
228 NTSTATUS
tdr_print_ipv4address(struct tdr_print
*tdr
, const char *name
,
229 const char **address
)
231 tdr
->print(tdr
, "%-25s: %s", name
, *address
);
238 NTSTATUS
tdr_pull_hyper(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, uint64_t *v
)
240 TDR_PULL_NEED_BYTES(tdr
, 8);
241 *v
= TDR_IVAL(tdr
, tdr
->offset
);
242 *v
|= (uint64_t)(TDR_IVAL(tdr
, tdr
->offset
+4)) << 32;
250 NTSTATUS
tdr_push_hyper(struct tdr_push
*tdr
, uint64_t *v
)
252 TDR_PUSH_NEED_BYTES(tdr
, 8);
253 TDR_SIVAL(tdr
, tdr
->data
.length
, ((*v
) & 0xFFFFFFFF));
254 TDR_SIVAL(tdr
, tdr
->data
.length
+4, ((*v
)>>32));
255 tdr
->data
.length
+= 8;
264 NTSTATUS
tdr_push_NTTIME(struct tdr_push
*tdr
, NTTIME
*t
)
266 TDR_CHECK(tdr_push_hyper(tdr
, t
));
273 NTSTATUS
tdr_pull_NTTIME(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, NTTIME
*t
)
275 TDR_CHECK(tdr_pull_hyper(tdr
, ctx
, t
));
282 NTSTATUS
tdr_push_time_t(struct tdr_push
*tdr
, time_t *t
)
284 return tdr_push_uint32(tdr
, (uint32_t *)t
);
290 NTSTATUS
tdr_pull_time_t(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, time_t *t
)
293 TDR_CHECK(tdr_pull_uint32(tdr
, ctx
, &tt
));
298 NTSTATUS
tdr_print_time_t(struct tdr_print
*tdr
, const char *name
, time_t *t
)
300 if (*t
== (time_t)-1 || *t
== 0) {
301 tdr
->print(tdr
, "%-25s: (time_t)%d", name
, (int)*t
);
303 tdr
->print(tdr
, "%-25s: %s", name
, timestring(tdr
, *t
));
309 NTSTATUS
tdr_print_NTTIME(struct tdr_print
*tdr
, const char *name
, NTTIME
*t
)
311 tdr
->print(tdr
, "%-25s: %s", name
, nt_time_string(tdr
, *t
));
316 NTSTATUS
tdr_print_DATA_BLOB(struct tdr_print
*tdr
, const char *name
, DATA_BLOB
*r
)
318 tdr
->print(tdr
, "%-25s: DATA_BLOB length=%u", name
, r
->length
);
320 dump_data(10, r
->data
, r
->length
);
326 #define TDR_ALIGN(l,n) (((l) & ((n)-1)) == 0?0:((n)-((l)&((n)-1))))
329 push a DATA_BLOB onto the wire.
331 NTSTATUS
tdr_push_DATA_BLOB(struct tdr_push
*tdr
, DATA_BLOB
*blob
)
333 if (tdr
->flags
& TDR_ALIGN2
) {
334 blob
->length
= TDR_ALIGN(tdr
->data
.length
, 2);
335 } else if (tdr
->flags
& TDR_ALIGN4
) {
336 blob
->length
= TDR_ALIGN(tdr
->data
.length
, 4);
337 } else if (tdr
->flags
& TDR_ALIGN8
) {
338 blob
->length
= TDR_ALIGN(tdr
->data
.length
, 8);
341 TDR_PUSH_NEED_BYTES(tdr
, blob
->length
);
343 memcpy(tdr
->data
.data
+tdr
->data
.length
, blob
->data
, blob
->length
);
348 pull a DATA_BLOB from the wire.
350 NTSTATUS
tdr_pull_DATA_BLOB(struct tdr_pull
*tdr
, TALLOC_CTX
*ctx
, DATA_BLOB
*blob
)
354 if (tdr
->flags
& TDR_ALIGN2
) {
355 length
= TDR_ALIGN(tdr
->offset
, 2);
356 } else if (tdr
->flags
& TDR_ALIGN4
) {
357 length
= TDR_ALIGN(tdr
->offset
, 4);
358 } else if (tdr
->flags
& TDR_ALIGN8
) {
359 length
= TDR_ALIGN(tdr
->offset
, 8);
360 } else if (tdr
->flags
& TDR_REMAINING
) {
361 length
= tdr
->data
.length
- tdr
->offset
;
363 return NT_STATUS_INVALID_PARAMETER
;
366 if (tdr
->data
.length
- tdr
->offset
< length
) {
367 length
= tdr
->data
.length
- tdr
->offset
;
370 TDR_PULL_NEED_BYTES(tdr
, length
);
372 *blob
= data_blob_talloc(tdr
, tdr
->data
.data
+tdr
->offset
, length
);
373 tdr
->offset
+= length
;
377 NTSTATUS
tdr_push_to_fd(int fd
, tdr_push_fn_t push_fn
, const void *p
)
379 struct tdr_push
*push
= talloc_zero(NULL
, struct tdr_push
);
382 return NT_STATUS_NO_MEMORY
;
384 if (NT_STATUS_IS_ERR(push_fn(push
, p
))) {
385 DEBUG(1, ("Error pushing data\n"));
387 return NT_STATUS_UNSUCCESSFUL
;
390 if (write(fd
, push
->data
.data
, push
->data
.length
) < push
->data
.length
) {
391 DEBUG(1, ("Error writing all data\n"));
392 return NT_STATUS_UNSUCCESSFUL
;
400 void tdr_print_debug_helper(struct tdr_print
*tdr
, const char *format
, ...) _PRINTF_ATTRIBUTE(2,3)
406 va_start(ap
, format
);
407 vasprintf(&s
, format
, ap
);
410 for (i
=0;i
<tdr
->level
;i
++) {
414 DEBUG(0,("%s\n", s
));