2 Unix SMB/CIFS implementation.
4 routines for marshalling/unmarshalling string 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.
26 pull a general string from the wire
28 NTSTATUS ndr_pull_string(struct ndr_pull *ndr, int ndr_flags, const char **s)
31 uint32_t len1, ofs, len2;
34 charset_t chset = CH_UCS2;
35 unsigned byte_mul = 2;
36 unsigned flags = ndr->flags;
37 unsigned c_len_term = 0;
39 if (!(ndr_flags & NDR_SCALARS)) {
43 SMB_ASSERT(!NDR_BE(ndr));
45 if (flags & LIBNDR_FLAG_STR_ASCII) {
48 flags &= ~LIBNDR_FLAG_STR_ASCII;
51 if (flags & LIBNDR_FLAG_STR_UTF8) {
54 flags &= ~LIBNDR_FLAG_STR_UTF8;
57 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
58 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
60 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
63 switch (flags & LIBNDR_STRING_FLAGS) {
64 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
65 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
66 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
67 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
69 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
70 ndr->flags & LIBNDR_STRING_FLAGS);
72 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len2));
74 return ndr_pull_error(ndr, NDR_ERR_STRING,
75 "Bad string lengths len1=%u ofs=%u len2=%u\n",
78 NDR_PULL_NEED_BYTES(ndr, (len2 + c_len_term)*byte_mul);
80 as = talloc_strdup(ndr->current_mem_ctx, "");
82 ret = convert_string_talloc(ndr->current_mem_ctx,
84 ndr->data+ndr->offset,
85 (len2 + c_len_term)*byte_mul,
88 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
89 "Bad character conversion");
92 NDR_CHECK(ndr_pull_advance(ndr, (len2 + c_len_term)*byte_mul));
95 DEBUG(6,("len1[%u] != len2[%u] '%s'\n", len1, len2, as));
98 /* this is a way of detecting if a string is sent with the wrong
100 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
101 if (strlen(as) < (len2 + c_len_term)) {
102 DEBUG(6,("short string '%s'\n", as));
105 if (strlen(as) == (len2 + c_len_term)) {
106 DEBUG(6,("long string '%s'\n", as));
112 case LIBNDR_FLAG_STR_SIZE4:
113 case LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
114 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
115 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
117 as = talloc_strdup(ndr->current_mem_ctx, "");
119 ret = convert_string_talloc(ndr->current_mem_ctx,
121 ndr->data+ndr->offset,
122 (len1 + c_len_term)*byte_mul,
125 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
126 "Bad character conversion");
129 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
131 /* this is a way of detecting if a string is sent with the wrong
133 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
134 if (strlen(as) < (len1 + c_len_term)) {
135 DEBUG(6,("short string '%s'\n", as));
138 if (strlen(as) == (len1 + c_len_term)) {
139 DEBUG(6,("long string '%s'\n", as));
145 case LIBNDR_FLAG_STR_LEN4:
146 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_NOTERM:
147 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
149 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
150 ndr->flags & LIBNDR_STRING_FLAGS);
152 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
153 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
155 as = talloc_strdup(ndr->current_mem_ctx, "");
157 ret = convert_string_talloc(ndr->current_mem_ctx,
159 ndr->data+ndr->offset,
160 (len1 + c_len_term)*byte_mul,
163 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
164 "Bad character conversion");
167 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
169 /* this is a way of detecting if a string is sent with the wrong
171 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
172 if (strlen(as) < (len1 + c_len_term)) {
173 DEBUG(6,("short string '%s'\n", as));
176 if (strlen(as) == (len1 + c_len_term)) {
177 DEBUG(6,("long string '%s'\n", as));
184 case LIBNDR_FLAG_STR_SIZE2:
185 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM:
186 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
187 NDR_PULL_NEED_BYTES(ndr, (len3 + c_len_term)*byte_mul);
189 as = talloc_strdup(ndr->current_mem_ctx, "");
191 ret = convert_string_talloc(ndr->current_mem_ctx,
193 ndr->data+ndr->offset,
194 (len3 + c_len_term)*byte_mul,
197 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
198 "Bad character conversion");
201 NDR_CHECK(ndr_pull_advance(ndr, (len3 + c_len_term)*byte_mul));
203 /* this is a way of detecting if a string is sent with the wrong
205 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
206 if (strlen(as) < (len3 + c_len_term)) {
207 DEBUG(6,("short string '%s'\n", as));
210 if (strlen(as) == (len3 + c_len_term)) {
211 DEBUG(6,("long string '%s'\n", as));
217 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
218 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
219 NDR_PULL_NEED_BYTES(ndr, len3);
221 as = talloc_strdup(ndr->current_mem_ctx, "");
223 ret = convert_string_talloc(ndr->current_mem_ctx,
225 ndr->data+ndr->offset,
228 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
229 "Bad character conversion");
232 NDR_CHECK(ndr_pull_advance(ndr, len3));
236 case LIBNDR_FLAG_STR_NULLTERM:
238 len1 = ascii_len_n((const char *)(ndr->data+ndr->offset), ndr->data_size - ndr->offset);
240 len1 = utf16_len_n(ndr->data+ndr->offset, ndr->data_size - ndr->offset);
242 ret = convert_string_talloc(ndr->current_mem_ctx,
244 ndr->data+ndr->offset,
247 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
248 "Bad character conversion");
250 NDR_CHECK(ndr_pull_advance(ndr, len1));
254 case LIBNDR_FLAG_STR_FIXLEN15:
255 case LIBNDR_FLAG_STR_FIXLEN32:
256 len1 = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
257 NDR_PULL_NEED_BYTES(ndr, len1*byte_mul);
258 ret = convert_string_talloc(ndr->current_mem_ctx,
260 ndr->data+ndr->offset,
261 len1*byte_mul, &as, False);
263 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
264 "Bad character conversion");
266 NDR_CHECK(ndr_pull_advance(ndr, len1*byte_mul));
271 return ndr_pull_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
272 ndr->flags & LIBNDR_STRING_FLAGS);
280 push a general string onto the wire
282 NTSTATUS ndr_push_string(struct ndr_push *ndr, int ndr_flags, const char *s)
284 ssize_t s_len, c_len, d_len;
285 charset_t chset = CH_UCS2;
286 unsigned flags = ndr->flags;
287 unsigned byte_mul = 2;
288 uint8_t *dest = NULL;
290 if (!(ndr_flags & NDR_SCALARS)) {
294 SMB_ASSERT(!NDR_BE(ndr));
296 s_len = s?strlen(s):0;
298 if (flags & LIBNDR_FLAG_STR_ASCII) {
301 flags &= ~LIBNDR_FLAG_STR_ASCII;
304 if (flags & LIBNDR_FLAG_STR_UTF8) {
307 flags &= ~LIBNDR_FLAG_STR_UTF8;
310 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
313 (LIBNDR_FLAG_STR_NOTERM |
314 LIBNDR_FLAG_STR_FIXLEN15 |
315 LIBNDR_FLAG_STR_FIXLEN32))) {
318 d_len = convert_string_talloc(ndr, CH_UNIX, chset, s, s_len, &dest,
321 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
322 "Bad character conversion");
325 if (flags & LIBNDR_FLAG_STR_BYTESIZE) {
327 flags &= ~LIBNDR_FLAG_STR_BYTESIZE;
328 } else if (flags & LIBNDR_FLAG_STR_CHARLEN) {
329 c_len = (d_len / byte_mul)-1;
330 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
332 c_len = d_len / byte_mul;
335 switch ((flags & LIBNDR_STRING_FLAGS) & ~LIBNDR_FLAG_STR_NOTERM) {
336 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
337 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
338 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
339 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
340 NDR_CHECK(ndr_push_bytes(ndr, dest, d_len));
343 case LIBNDR_FLAG_STR_LEN4:
344 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
345 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
346 NDR_CHECK(ndr_push_bytes(ndr, dest, d_len));
349 case LIBNDR_FLAG_STR_SIZE4:
350 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
351 NDR_CHECK(ndr_push_bytes(ndr, dest, d_len));
354 case LIBNDR_FLAG_STR_SIZE2:
355 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len));
356 NDR_CHECK(ndr_push_bytes(ndr, dest, d_len));
359 case LIBNDR_FLAG_STR_NULLTERM:
360 NDR_CHECK(ndr_push_bytes(ndr, dest, d_len));
363 case LIBNDR_FLAG_STR_FIXLEN15:
364 case LIBNDR_FLAG_STR_FIXLEN32: {
365 ssize_t fix_len = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
366 uint32_t pad_len = fix_len - d_len;
367 if (d_len > fix_len) {
368 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
369 "Bad character conversion");
371 NDR_CHECK(ndr_push_bytes(ndr, dest, d_len));
373 NDR_CHECK(ndr_push_zero(ndr, pad_len));
379 return ndr_push_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
380 ndr->flags & LIBNDR_STRING_FLAGS);
389 push a general string onto the wire
391 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s)
394 unsigned flags = ndr->flags;
395 unsigned byte_mul = 2;
396 unsigned c_len_term = 1;
398 if (flags & LIBNDR_FLAG_STR_FIXLEN32) {
401 if (flags & LIBNDR_FLAG_STR_FIXLEN15) {
405 c_len = s?strlen(s):0;
407 if (flags & (LIBNDR_FLAG_STR_ASCII|LIBNDR_FLAG_STR_UTF8)) {
411 if (flags & LIBNDR_FLAG_STR_NOTERM) {
415 c_len = c_len + c_len_term;
417 if (flags & LIBNDR_FLAG_STR_BYTESIZE) {
418 c_len = c_len * byte_mul;
424 void ndr_print_string(struct ndr_print *ndr, const char *name, const char *s)
427 ndr->print(ndr, "%-25s: '%s'", name, s);
429 ndr->print(ndr, "%-25s: NULL", name);
433 uint32_t ndr_size_string(int ret, const char * const* string, int flags)
435 /* FIXME: Is this correct for all strings ? */
436 if(!(*string)) return ret;
437 return ret+strlen(*string)+1;
441 pull a general string array from the wire
443 NTSTATUS ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a)
445 const char **a = *_a;
448 if (!(ndr_flags & NDR_SCALARS)) {
452 for (count = 0;; count++) {
454 const char *s = NULL;
455 a = talloc_realloc(ndr->current_mem_ctx, a, const char *, count + 2);
456 NT_STATUS_HAVE_NO_MEMORY(a);
460 tmp_ctx = ndr->current_mem_ctx;
461 ndr->current_mem_ctx = a;
462 NDR_CHECK(ndr_pull_string(ndr, ndr_flags, &s));
463 ndr->current_mem_ctx = tmp_ctx;
464 if (strcmp("", s)==0) {
477 push a general string array onto the wire
479 NTSTATUS ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a)
483 if (!(ndr_flags & NDR_SCALARS)) {
487 for (count = 0; a && a[count]; count++) {
488 NDR_CHECK(ndr_push_string(ndr, ndr_flags, a[count]));
491 NDR_CHECK(ndr_push_string(ndr, ndr_flags, ""));
496 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a)
501 for (count = 0; a && a[count]; count++) {}
503 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
505 for (i=0;i<count;i++) {
507 asprintf(&idx, "[%d]", i);
509 ndr_print_string(ndr, idx, a[i]);
517 * Return number of elements in a string including the last (zeroed) element
519 uint32_t ndr_string_length(const void *_var, uint32_t element_size)
522 uint8_t zero[4] = {0,0,0,0};
523 const char *var = (const char *)_var;
525 for (i = 0; memcmp(var+i*element_size,zero,element_size) != 0; i++);
530 NTSTATUS ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size)
533 struct ndr_pull_save save_offset;
535 ndr_pull_save(ndr, &save_offset);
536 ndr_pull_advance(ndr, (count - 1) * element_size);
537 NDR_PULL_NEED_BYTES(ndr, element_size);
539 for (i = 0; i < element_size; i++) {
540 if (ndr->data[ndr->offset+i] != 0) {
541 ndr_pull_restore(ndr, &save_offset);
543 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, "String terminator not present or outside string boundaries");
547 ndr_pull_restore(ndr, &save_offset);
552 NTSTATUS ndr_pull_charset(struct ndr_pull *ndr, int ndr_flags, const char **var, uint32_t length, uint8_t byte_mul, int chset)
556 *var = talloc_strdup(ndr->current_mem_ctx, "");
560 SMB_ASSERT (!NDR_BE(ndr) || chset != CH_UCS2);
562 NDR_PULL_NEED_BYTES(ndr, length*byte_mul);
564 ret = convert_string_talloc(ndr->current_mem_ctx,
566 ndr->data+ndr->offset,
570 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
571 "Bad character conversion");
573 NDR_CHECK(ndr_pull_advance(ndr, length*byte_mul));
578 NTSTATUS ndr_push_charset(struct ndr_push *ndr, int ndr_flags, const char *var,
579 uint32_t length, uint8_t byte_mul, charset_t chset)
581 ssize_t ret, required;
583 SMB_ASSERT(!NDR_BE(ndr) || chset != CH_UCS2);
585 required = byte_mul * length;
587 NDR_PUSH_NEED_BYTES(ndr, required);
588 ret = convert_string(CH_UNIX, chset,
590 ndr->data+ndr->offset, required, False);
592 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
593 "Bad character conversion");
596 /* Make sure the remaining part of the string is filled with zeroes */
597 if (ret < required) {
598 memset(ndr->data+ndr->offset+ret, 0, required-ret);
601 ndr->offset += required;
606 /* Return number of elements in a string in the specified charset */
607 uint32_t ndr_charset_length(const void *var, int chset)
609 /* FIXME: Treat special chars special here, taking chset into account */
610 /* Also include 0 byte */
611 return strlen((const char *)var)+1;