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.
24 #include "system/network.h"
27 pull a general string from the wire
29 NTSTATUS ndr_pull_string(struct ndr_pull *ndr, int ndr_flags, const char **s)
32 uint32_t len1, ofs, len2;
36 unsigned byte_mul = 2;
37 unsigned flags = ndr->flags;
38 unsigned c_len_term = 0;
40 if (!(ndr_flags & NDR_SCALARS)) {
48 if (flags & LIBNDR_FLAG_STR_ASCII) {
51 flags &= ~LIBNDR_FLAG_STR_ASCII;
54 if (flags & LIBNDR_FLAG_STR_UTF8) {
57 flags &= ~LIBNDR_FLAG_STR_UTF8;
60 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
61 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
63 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
66 switch (flags & LIBNDR_STRING_FLAGS) {
67 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
68 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
69 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_LARGE_SIZE:
70 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
71 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
73 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
74 ndr->flags & LIBNDR_STRING_FLAGS);
76 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len2));
78 return ndr_pull_error(ndr, NDR_ERR_STRING,
79 "Bad string lengths len1=%u ofs=%u len2=%u\n",
82 NDR_PULL_NEED_BYTES(ndr, (len2 + c_len_term)*byte_mul);
84 as = talloc_strdup(ndr->current_mem_ctx, "");
86 ret = convert_string_talloc(ndr->current_mem_ctx,
88 ndr->data+ndr->offset,
89 (len2 + c_len_term)*byte_mul,
92 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
93 "Bad character conversion");
96 NDR_CHECK(ndr_pull_advance(ndr, (len2 + c_len_term)*byte_mul));
98 if (ndr->flags & LIBNDR_FLAG_STR_LARGE_SIZE) {
99 if (len1 != 0 && len2 == 0) {
100 DEBUG(6,("len1[%u] != (len2[%u]) '%s'\n", len1, len2, as));
101 } else if (len1 != (len2 + 1)) {
102 DEBUG(6,("len1[%u] != (len2[%u]+1) '%s'\n", len1, len2, as));
106 DEBUG(6,("len1[%u] != len2[%u] '%s'\n", len1, len2, as));
110 /* this is a way of detecting if a string is sent with the wrong
112 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
113 if (strlen(as) < (len2 + c_len_term)) {
114 DEBUG(6,("short string '%s'\n", as));
117 if (strlen(as) == (len2 + c_len_term)) {
118 DEBUG(6,("long string '%s'\n", as));
124 case LIBNDR_FLAG_STR_SIZE4:
125 case LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
126 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
127 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
129 as = talloc_strdup(ndr->current_mem_ctx, "");
131 ret = convert_string_talloc(ndr->current_mem_ctx,
133 ndr->data+ndr->offset,
134 (len1 + c_len_term)*byte_mul,
137 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
138 "Bad character conversion");
141 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
143 /* this is a way of detecting if a string is sent with the wrong
145 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
146 if (strlen(as) < (len1 + c_len_term)) {
147 DEBUG(6,("short string '%s'\n", as));
150 if (strlen(as) == (len1 + c_len_term)) {
151 DEBUG(6,("long string '%s'\n", as));
157 case LIBNDR_FLAG_STR_LEN4:
158 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_NOTERM:
159 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
161 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
162 ndr->flags & LIBNDR_STRING_FLAGS);
164 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
165 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
167 as = talloc_strdup(ndr->current_mem_ctx, "");
169 ret = convert_string_talloc(ndr->current_mem_ctx,
171 ndr->data+ndr->offset,
172 (len1 + c_len_term)*byte_mul,
175 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
176 "Bad character conversion");
179 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
181 /* this is a way of detecting if a string is sent with the wrong
183 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
184 if (strlen(as) < (len1 + c_len_term)) {
185 DEBUG(6,("short string '%s'\n", as));
188 if (strlen(as) == (len1 + c_len_term)) {
189 DEBUG(6,("long string '%s'\n", as));
196 case LIBNDR_FLAG_STR_SIZE2:
197 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM:
198 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
199 NDR_PULL_NEED_BYTES(ndr, (len3 + c_len_term)*byte_mul);
201 as = talloc_strdup(ndr->current_mem_ctx, "");
203 ret = convert_string_talloc(ndr->current_mem_ctx,
205 ndr->data+ndr->offset,
206 (len3 + c_len_term)*byte_mul,
209 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
210 "Bad character conversion");
213 NDR_CHECK(ndr_pull_advance(ndr, (len3 + c_len_term)*byte_mul));
215 /* this is a way of detecting if a string is sent with the wrong
217 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
218 if (strlen(as) < (len3 + c_len_term)) {
219 DEBUG(6,("short string '%s'\n", as));
222 if (strlen(as) == (len3 + c_len_term)) {
223 DEBUG(6,("long string '%s'\n", as));
229 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
230 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
231 NDR_PULL_NEED_BYTES(ndr, len3);
233 as = talloc_strdup(ndr->current_mem_ctx, "");
235 ret = convert_string_talloc(ndr->current_mem_ctx,
237 ndr->data+ndr->offset,
241 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
242 "Bad character conversion");
245 NDR_CHECK(ndr_pull_advance(ndr, len3));
249 case LIBNDR_FLAG_STR_NULLTERM:
251 len1 = ascii_len_n((const char *)(ndr->data+ndr->offset), ndr->data_size - ndr->offset);
253 len1 = utf16_len_n(ndr->data+ndr->offset, ndr->data_size - ndr->offset);
255 ret = convert_string_talloc(ndr->current_mem_ctx,
257 ndr->data+ndr->offset,
261 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
262 "Bad character conversion");
264 NDR_CHECK(ndr_pull_advance(ndr, len1));
268 case LIBNDR_FLAG_STR_FIXLEN15:
269 case LIBNDR_FLAG_STR_FIXLEN32:
270 len1 = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
271 NDR_PULL_NEED_BYTES(ndr, len1*byte_mul);
272 ret = convert_string_talloc(ndr->current_mem_ctx,
274 ndr->data+ndr->offset,
278 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
279 "Bad character conversion");
281 NDR_CHECK(ndr_pull_advance(ndr, len1*byte_mul));
286 return ndr_pull_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
287 ndr->flags & LIBNDR_STRING_FLAGS);
295 push a general string onto the wire
297 NTSTATUS ndr_push_string(struct ndr_push *ndr, int ndr_flags, const char *s)
299 ssize_t s_len, c_len, d_len;
301 int chset = CH_UTF16;
302 unsigned flags = ndr->flags;
303 unsigned byte_mul = 2;
304 unsigned c_len_term = 1;
306 if (!(ndr_flags & NDR_SCALARS)) {
314 s_len = s?strlen(s):0;
315 c_len = s?strlen_m(s):0;
317 if (flags & LIBNDR_FLAG_STR_ASCII) {
320 flags &= ~LIBNDR_FLAG_STR_ASCII;
323 if (flags & LIBNDR_FLAG_STR_UTF8) {
326 flags &= ~LIBNDR_FLAG_STR_UTF8;
329 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
331 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
333 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
336 switch (flags & LIBNDR_STRING_FLAGS) {
337 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
338 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
339 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
340 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
341 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
342 ret = convert_string(CH_UNIX, chset,
344 ndr->data+ndr->offset,
347 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
348 "Bad character conversion");
350 ndr->offset += byte_mul*(c_len+1);
353 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
355 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_LARGE_SIZE:
356 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
357 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
358 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
359 NDR_PUSH_NEED_BYTES(ndr, c_len*byte_mul);
360 ret = convert_string(CH_UNIX, chset,
362 ndr->data+ndr->offset, c_len*byte_mul);
364 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
365 "Bad character conversion");
367 ndr->offset += c_len*byte_mul;
370 case LIBNDR_FLAG_STR_LEN4:
371 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
372 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len + c_len_term));
373 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
374 ret = convert_string(CH_UNIX, chset,
376 ndr->data+ndr->offset, byte_mul*(c_len+1));
378 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
379 "Bad character conversion");
381 ndr->offset += byte_mul*(c_len+1);
384 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_NOTERM:
385 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
386 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
387 NDR_PUSH_NEED_BYTES(ndr, byte_mul*c_len);
388 ret = convert_string(CH_UNIX, chset,
390 ndr->data+ndr->offset, byte_mul*c_len);
392 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
393 "Bad character conversion");
395 ndr->offset += byte_mul*c_len;
398 case LIBNDR_FLAG_STR_SIZE4:
399 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len + c_len_term));
400 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
401 ret = convert_string(CH_UNIX, chset,
403 ndr->data+ndr->offset, byte_mul*(c_len+1));
405 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
406 "Bad character conversion");
408 ndr->offset += byte_mul*(c_len+1);
411 case LIBNDR_FLAG_STR_SIZE2:
412 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len + c_len_term));
413 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
414 ret = convert_string(CH_UNIX, chset,
416 ndr->data+ndr->offset, byte_mul*(c_len+1));
418 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
419 "Bad character conversion");
421 ndr->offset += byte_mul*(c_len+1);
424 case LIBNDR_FLAG_STR_NULLTERM:
425 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
426 ret = convert_string(CH_UNIX, chset,
428 ndr->data+ndr->offset, byte_mul*(c_len+1));
430 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
431 "Bad character conversion");
433 ndr->offset += byte_mul*(c_len+1);
436 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
437 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len*byte_mul));
438 NDR_PUSH_NEED_BYTES(ndr, c_len*byte_mul);
439 ret = convert_string(CH_UNIX, chset,
441 ndr->data+ndr->offset, c_len*byte_mul);
443 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
444 "Bad character conversion");
446 ndr->offset += c_len*byte_mul;
449 case LIBNDR_FLAG_STR_FIXLEN15:
450 case LIBNDR_FLAG_STR_FIXLEN32:
451 d_len = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
452 NDR_PUSH_NEED_BYTES(ndr, byte_mul*d_len);
453 ret = convert_string(CH_UNIX, chset,
455 ndr->data+ndr->offset, byte_mul*d_len);
457 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
458 "Bad character conversion");
461 if ((byte_mul*d_len) > ret) {
462 uint32_t _padding_len = (byte_mul*d_len) - ret;
463 NDR_CHECK(ndr_push_zero(ndr, _padding_len));
468 return ndr_push_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
469 ndr->flags & LIBNDR_STRING_FLAGS);
476 push a general string onto the wire
478 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s)
481 unsigned flags = ndr->flags;
482 unsigned byte_mul = 2;
483 unsigned c_len_term = 1;
485 if (flags & LIBNDR_FLAG_STR_FIXLEN32) {
488 if (flags & LIBNDR_FLAG_STR_FIXLEN15) {
492 c_len = s?strlen_m(s):0;
494 if (flags & (LIBNDR_FLAG_STR_ASCII|LIBNDR_FLAG_STR_UTF8)) {
498 if (flags & LIBNDR_FLAG_STR_NOTERM) {
502 c_len = c_len + c_len_term;
504 if (flags & LIBNDR_FLAG_STR_BYTESIZE) {
505 c_len = c_len * byte_mul;
511 void ndr_print_string(struct ndr_print *ndr, const char *name, const char *s)
514 ndr->print(ndr, "%-25s: '%s'", name, s);
516 ndr->print(ndr, "%-25s: NULL", name);
520 uint32_t ndr_size_string(int ret, const char * const* string, int flags)
522 /* FIXME: Is this correct for all strings ? */
523 if(!(*string)) return ret;
524 return ret+strlen(*string)+1;
528 pull a general string array from the wire
530 NTSTATUS ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a)
532 const char **a = *_a;
535 if (!(ndr_flags & NDR_SCALARS)) {
539 for (count = 0;; count++) {
541 const char *s = NULL;
542 a = talloc_realloc(ndr->current_mem_ctx, a, const char *, count + 2);
543 NT_STATUS_HAVE_NO_MEMORY(a);
547 tmp_ctx = ndr->current_mem_ctx;
548 ndr->current_mem_ctx = a;
549 NDR_CHECK(ndr_pull_string(ndr, ndr_flags, &s));
550 ndr->current_mem_ctx = tmp_ctx;
551 if (strcmp("", s)==0) {
564 push a general string array onto the wire
566 NTSTATUS ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a)
570 if (!(ndr_flags & NDR_SCALARS)) {
574 for (count = 0; a && a[count]; count++) {
575 NDR_CHECK(ndr_push_string(ndr, ndr_flags, a[count]));
578 NDR_CHECK(ndr_push_string(ndr, ndr_flags, ""));
583 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a)
588 for (count = 0; a && a[count]; count++) {}
590 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
592 for (i=0;i<count;i++) {
594 asprintf(&idx, "[%d]", i);
596 ndr_print_string(ndr, idx, a[i]);
603 /* Return number of elements in a string including the last (zeroed) element */
604 uint32_t ndr_string_length(const void *_var, uint32_t element_size)
607 uint8_t zero[4] = {0,0,0,0};
608 const char *var = _var;
610 for (i = 0; memcmp(var+i*element_size,zero,element_size) != 0; i++);
615 NTSTATUS ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size)
618 struct ndr_pull_save save_offset;
620 ndr_pull_save(ndr, &save_offset);
621 ndr_pull_advance(ndr, (count - 1) * element_size);
622 NDR_PULL_NEED_BYTES(ndr, element_size);
624 for (i = 0; i < element_size; i++) {
625 if (ndr->data[ndr->offset+i] != 0) {
626 ndr_pull_restore(ndr, &save_offset);
628 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, "String terminator not present or outside string boundaries");
632 ndr_pull_restore(ndr, &save_offset);
637 NTSTATUS ndr_pull_charset(struct ndr_pull *ndr, int ndr_flags, const char **var, uint32_t length, uint8_t byte_mul, int chset)
641 *var = talloc_strdup(ndr->current_mem_ctx, "");
645 NDR_PULL_NEED_BYTES(ndr, length*byte_mul);
647 if (ndr->flags & LIBNDR_FLAG_STR_NULLTERM) {
648 /* Explicitly ignore the return value here. An array that
649 * is not zero-terminated is considered a warning only, not fatal */
650 ndr_check_string_terminator(ndr, length, byte_mul);
653 ret = convert_string_talloc(ndr->current_mem_ctx,
655 ndr->data+ndr->offset,
657 discard_const_p(void *, var));
659 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
660 "Bad character conversion");
662 NDR_CHECK(ndr_pull_advance(ndr, length*byte_mul));
667 NTSTATUS ndr_push_charset(struct ndr_push *ndr, int ndr_flags, const char *var, uint32_t length, uint8_t byte_mul, int chset)
669 ssize_t ret, required;
671 required = byte_mul * length;
673 NDR_PUSH_NEED_BYTES(ndr, required);
674 ret = convert_string(CH_UNIX, chset,
676 ndr->data+ndr->offset, required);
678 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
679 "Bad character conversion");
682 /* Make sure the remaining part of the string is filled with zeroes */
683 if (ret < required) {
684 memset(ndr->data+ndr->offset+ret, 0, required-ret);
687 ndr->offset += required;
692 /* Return number of elements in a string in the specified charset */
693 uint32_t ndr_charset_length(const void *var, int chset)
695 /* FIXME: Treat special chars special here, taking chset into account */
696 /* Also include 0 byte */
697 return strlen(var)+1;