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;
35 unsigned byte_mul = 2;
36 unsigned flags = ndr->flags;
37 unsigned c_len_term = 0;
39 if (!(ndr_flags & NDR_SCALARS)) {
47 if (flags & LIBNDR_FLAG_STR_ASCII) {
50 flags &= ~LIBNDR_FLAG_STR_ASCII;
53 if (flags & LIBNDR_FLAG_STR_UTF8) {
56 flags &= ~LIBNDR_FLAG_STR_UTF8;
59 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
60 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
62 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
65 switch (flags & LIBNDR_STRING_FLAGS) {
66 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
67 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
68 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_LARGE_SIZE:
69 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
70 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
72 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
73 ndr->flags & LIBNDR_STRING_FLAGS);
75 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len2));
77 return ndr_pull_error(ndr, NDR_ERR_STRING,
78 "Bad string lengths len1=%u ofs=%u len2=%u\n",
81 NDR_PULL_NEED_BYTES(ndr, (len2 + c_len_term)*byte_mul);
83 as = talloc_strdup(ndr->current_mem_ctx, "");
85 ret = convert_string_talloc(ndr->current_mem_ctx,
87 ndr->data+ndr->offset,
88 (len2 + c_len_term)*byte_mul,
91 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
92 "Bad character conversion");
95 NDR_CHECK(ndr_pull_advance(ndr, (len2 + c_len_term)*byte_mul));
97 if (ndr->flags & LIBNDR_FLAG_STR_LARGE_SIZE) {
98 if (len1 != 0 && len2 == 0) {
99 DEBUG(6,("len1[%u] != (len2[%u]) '%s'\n", len1, len2, as));
100 } else if (len1 != (len2 + 1)) {
101 DEBUG(6,("len1[%u] != (len2[%u]+1) '%s'\n", len1, len2, as));
105 DEBUG(6,("len1[%u] != len2[%u] '%s'\n", len1, len2, as));
109 /* this is a way of detecting if a string is sent with the wrong
111 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
112 if (strlen(as) < (len2 + c_len_term)) {
113 DEBUG(6,("short string '%s'\n", as));
116 if (strlen(as) == (len2 + c_len_term)) {
117 DEBUG(6,("long string '%s'\n", as));
123 case LIBNDR_FLAG_STR_SIZE4:
124 case LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
125 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
126 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
128 as = talloc_strdup(ndr->current_mem_ctx, "");
130 ret = convert_string_talloc(ndr->current_mem_ctx,
132 ndr->data+ndr->offset,
133 (len1 + c_len_term)*byte_mul,
136 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
137 "Bad character conversion");
140 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
142 /* this is a way of detecting if a string is sent with the wrong
144 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
145 if (strlen(as) < (len1 + c_len_term)) {
146 DEBUG(6,("short string '%s'\n", as));
149 if (strlen(as) == (len1 + c_len_term)) {
150 DEBUG(6,("long string '%s'\n", as));
156 case LIBNDR_FLAG_STR_LEN4:
157 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_NOTERM:
158 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &ofs));
160 return ndr_pull_error(ndr, NDR_ERR_STRING, "non-zero array offset with string flags 0x%x\n",
161 ndr->flags & LIBNDR_STRING_FLAGS);
163 NDR_CHECK(ndr_pull_uint32(ndr, NDR_SCALARS, &len1));
164 NDR_PULL_NEED_BYTES(ndr, (len1 + c_len_term)*byte_mul);
166 as = talloc_strdup(ndr->current_mem_ctx, "");
168 ret = convert_string_talloc(ndr->current_mem_ctx,
170 ndr->data+ndr->offset,
171 (len1 + c_len_term)*byte_mul,
174 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
175 "Bad character conversion");
178 NDR_CHECK(ndr_pull_advance(ndr, (len1 + c_len_term)*byte_mul));
180 /* this is a way of detecting if a string is sent with the wrong
182 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
183 if (strlen(as) < (len1 + c_len_term)) {
184 DEBUG(6,("short string '%s'\n", as));
187 if (strlen(as) == (len1 + c_len_term)) {
188 DEBUG(6,("long string '%s'\n", as));
195 case LIBNDR_FLAG_STR_SIZE2:
196 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM:
197 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
198 NDR_PULL_NEED_BYTES(ndr, (len3 + c_len_term)*byte_mul);
200 as = talloc_strdup(ndr->current_mem_ctx, "");
202 ret = convert_string_talloc(ndr->current_mem_ctx,
204 ndr->data+ndr->offset,
205 (len3 + c_len_term)*byte_mul,
208 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
209 "Bad character conversion");
212 NDR_CHECK(ndr_pull_advance(ndr, (len3 + c_len_term)*byte_mul));
214 /* this is a way of detecting if a string is sent with the wrong
216 if (ndr->flags & LIBNDR_FLAG_STR_NOTERM) {
217 if (strlen(as) < (len3 + c_len_term)) {
218 DEBUG(6,("short string '%s'\n", as));
221 if (strlen(as) == (len3 + c_len_term)) {
222 DEBUG(6,("long string '%s'\n", as));
228 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
229 NDR_CHECK(ndr_pull_uint16(ndr, NDR_SCALARS, &len3));
230 NDR_PULL_NEED_BYTES(ndr, len3);
232 as = talloc_strdup(ndr->current_mem_ctx, "");
234 ret = convert_string_talloc(ndr->current_mem_ctx,
236 ndr->data+ndr->offset,
240 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
241 "Bad character conversion");
244 NDR_CHECK(ndr_pull_advance(ndr, len3));
248 case LIBNDR_FLAG_STR_NULLTERM:
250 len1 = ascii_len_n((const char *)(ndr->data+ndr->offset), ndr->data_size - ndr->offset);
252 len1 = utf16_len_n(ndr->data+ndr->offset, ndr->data_size - ndr->offset);
254 ret = convert_string_talloc(ndr->current_mem_ctx,
256 ndr->data+ndr->offset,
260 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
261 "Bad character conversion");
263 NDR_CHECK(ndr_pull_advance(ndr, len1));
267 case LIBNDR_FLAG_STR_FIXLEN15:
268 case LIBNDR_FLAG_STR_FIXLEN32:
269 len1 = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
270 NDR_PULL_NEED_BYTES(ndr, len1*byte_mul);
271 ret = convert_string_talloc(ndr->current_mem_ctx,
273 ndr->data+ndr->offset,
277 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
278 "Bad character conversion");
280 NDR_CHECK(ndr_pull_advance(ndr, len1*byte_mul));
285 return ndr_pull_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
286 ndr->flags & LIBNDR_STRING_FLAGS);
294 push a general string onto the wire
296 NTSTATUS ndr_push_string(struct ndr_push *ndr, int ndr_flags, const char *s)
298 ssize_t s_len, c_len, d_len;
300 int chset = CH_UTF16;
301 unsigned flags = ndr->flags;
302 unsigned byte_mul = 2;
303 unsigned c_len_term = 1;
305 if (!(ndr_flags & NDR_SCALARS)) {
313 s_len = s?strlen(s):0;
314 c_len = s?strlen_m(s):0;
316 if (flags & LIBNDR_FLAG_STR_ASCII) {
319 flags &= ~LIBNDR_FLAG_STR_ASCII;
322 if (flags & LIBNDR_FLAG_STR_UTF8) {
325 flags &= ~LIBNDR_FLAG_STR_UTF8;
328 flags &= ~LIBNDR_FLAG_STR_CONFORMANT;
330 if (flags & LIBNDR_FLAG_STR_CHARLEN) {
332 flags &= ~LIBNDR_FLAG_STR_CHARLEN;
335 switch (flags & LIBNDR_STRING_FLAGS) {
336 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4:
337 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
338 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
339 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
340 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
341 ret = convert_string(CH_UNIX, chset,
343 ndr->data+ndr->offset,
346 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
347 "Bad character conversion");
349 ndr->offset += byte_mul*(c_len+1);
352 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM:
354 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_SIZE4|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_LARGE_SIZE:
355 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len+c_len_term));
356 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
357 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
358 NDR_PUSH_NEED_BYTES(ndr, c_len*byte_mul);
359 ret = convert_string(CH_UNIX, chset,
361 ndr->data+ndr->offset, c_len*byte_mul);
363 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
364 "Bad character conversion");
366 ndr->offset += c_len*byte_mul;
369 case LIBNDR_FLAG_STR_LEN4:
370 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
371 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len + c_len_term));
372 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
373 ret = convert_string(CH_UNIX, chset,
375 ndr->data+ndr->offset, byte_mul*(c_len+1));
377 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
378 "Bad character conversion");
380 ndr->offset += byte_mul*(c_len+1);
383 case LIBNDR_FLAG_STR_LEN4|LIBNDR_FLAG_STR_NOTERM:
384 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, 0));
385 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len));
386 NDR_PUSH_NEED_BYTES(ndr, byte_mul*c_len);
387 ret = convert_string(CH_UNIX, chset,
389 ndr->data+ndr->offset, byte_mul*c_len);
391 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
392 "Bad character conversion");
394 ndr->offset += byte_mul*c_len;
397 case LIBNDR_FLAG_STR_SIZE4:
398 NDR_CHECK(ndr_push_uint32(ndr, NDR_SCALARS, c_len + c_len_term));
399 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
400 ret = convert_string(CH_UNIX, chset,
402 ndr->data+ndr->offset, byte_mul*(c_len+1));
404 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
405 "Bad character conversion");
407 ndr->offset += byte_mul*(c_len+1);
410 case LIBNDR_FLAG_STR_SIZE2:
411 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len + c_len_term));
412 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
413 ret = convert_string(CH_UNIX, chset,
415 ndr->data+ndr->offset, byte_mul*(c_len+1));
417 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
418 "Bad character conversion");
420 ndr->offset += byte_mul*(c_len+1);
423 case LIBNDR_FLAG_STR_NULLTERM:
424 NDR_PUSH_NEED_BYTES(ndr, byte_mul*(c_len+1));
425 ret = convert_string(CH_UNIX, chset,
427 ndr->data+ndr->offset, byte_mul*(c_len+1));
429 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
430 "Bad character conversion");
432 ndr->offset += byte_mul*(c_len+1);
435 case LIBNDR_FLAG_STR_SIZE2|LIBNDR_FLAG_STR_NOTERM|LIBNDR_FLAG_STR_BYTESIZE:
436 NDR_CHECK(ndr_push_uint16(ndr, NDR_SCALARS, c_len*byte_mul));
437 NDR_PUSH_NEED_BYTES(ndr, c_len*byte_mul);
438 ret = convert_string(CH_UNIX, chset,
440 ndr->data+ndr->offset, c_len*byte_mul);
442 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
443 "Bad character conversion");
445 ndr->offset += c_len*byte_mul;
448 case LIBNDR_FLAG_STR_FIXLEN15:
449 case LIBNDR_FLAG_STR_FIXLEN32:
450 d_len = (flags & LIBNDR_FLAG_STR_FIXLEN32)?32:15;
451 NDR_PUSH_NEED_BYTES(ndr, byte_mul*d_len);
452 ret = convert_string(CH_UNIX, chset,
454 ndr->data+ndr->offset, byte_mul*d_len);
456 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
457 "Bad character conversion");
460 if ((byte_mul*d_len) > ret) {
461 uint32_t _padding_len = (byte_mul*d_len) - ret;
462 NDR_CHECK(ndr_push_zero(ndr, _padding_len));
467 return ndr_push_error(ndr, NDR_ERR_STRING, "Bad string flags 0x%x\n",
468 ndr->flags & LIBNDR_STRING_FLAGS);
475 push a general string onto the wire
477 size_t ndr_string_array_size(struct ndr_push *ndr, const char *s)
480 unsigned flags = ndr->flags;
481 unsigned byte_mul = 2;
482 unsigned c_len_term = 1;
484 if (flags & LIBNDR_FLAG_STR_FIXLEN32) {
487 if (flags & LIBNDR_FLAG_STR_FIXLEN15) {
491 c_len = s?strlen_m(s):0;
493 if (flags & (LIBNDR_FLAG_STR_ASCII|LIBNDR_FLAG_STR_UTF8)) {
497 if (flags & LIBNDR_FLAG_STR_NOTERM) {
501 c_len = c_len + c_len_term;
503 if (flags & LIBNDR_FLAG_STR_BYTESIZE) {
504 c_len = c_len * byte_mul;
510 void ndr_print_string(struct ndr_print *ndr, const char *name, const char *s)
513 ndr->print(ndr, "%-25s: '%s'", name, s);
515 ndr->print(ndr, "%-25s: NULL", name);
519 uint32_t ndr_size_string(int ret, const char * const* string, int flags)
521 /* FIXME: Is this correct for all strings ? */
522 if(!(*string)) return ret;
523 return ret+strlen(*string)+1;
527 pull a general string array from the wire
529 NTSTATUS ndr_pull_string_array(struct ndr_pull *ndr, int ndr_flags, const char ***_a)
531 const char **a = *_a;
534 if (!(ndr_flags & NDR_SCALARS)) {
538 for (count = 0;; count++) {
540 const char *s = NULL;
541 a = talloc_realloc(ndr->current_mem_ctx, a, const char *, count + 2);
542 NT_STATUS_HAVE_NO_MEMORY(a);
546 tmp_ctx = ndr->current_mem_ctx;
547 ndr->current_mem_ctx = a;
548 NDR_CHECK(ndr_pull_string(ndr, ndr_flags, &s));
549 ndr->current_mem_ctx = tmp_ctx;
550 if (strcmp("", s)==0) {
563 push a general string array onto the wire
565 NTSTATUS ndr_push_string_array(struct ndr_push *ndr, int ndr_flags, const char **a)
569 if (!(ndr_flags & NDR_SCALARS)) {
573 for (count = 0; a && a[count]; count++) {
574 NDR_CHECK(ndr_push_string(ndr, ndr_flags, a[count]));
577 NDR_CHECK(ndr_push_string(ndr, ndr_flags, ""));
582 void ndr_print_string_array(struct ndr_print *ndr, const char *name, const char **a)
587 for (count = 0; a && a[count]; count++) {}
589 ndr->print(ndr, "%s: ARRAY(%d)", name, count);
591 for (i=0;i<count;i++) {
593 asprintf(&idx, "[%d]", i);
595 ndr_print_string(ndr, idx, a[i]);
602 /* Return number of elements in a string including the last (zeroed) element */
603 uint32_t ndr_string_length(const void *_var, uint32_t element_size)
606 uint8_t zero[4] = {0,0,0,0};
607 const char *var = _var;
609 for (i = 0; memcmp(var+i*element_size,zero,element_size) != 0; i++);
614 NTSTATUS ndr_check_string_terminator(struct ndr_pull *ndr, uint32_t count, uint32_t element_size)
617 struct ndr_pull_save save_offset;
619 ndr_pull_save(ndr, &save_offset);
620 ndr_pull_advance(ndr, (count - 1) * element_size);
621 NDR_PULL_NEED_BYTES(ndr, element_size);
623 for (i = 0; i < element_size; i++) {
624 if (ndr->data[ndr->offset+i] != 0) {
625 ndr_pull_restore(ndr, &save_offset);
627 return ndr_pull_error(ndr, NDR_ERR_ARRAY_SIZE, "String terminator not present or outside string boundaries");
631 ndr_pull_restore(ndr, &save_offset);
636 NTSTATUS ndr_pull_charset(struct ndr_pull *ndr, int ndr_flags, const char **var, uint32_t length, uint8_t byte_mul, int chset)
640 *var = talloc_strdup(ndr->current_mem_ctx, "");
644 NDR_PULL_NEED_BYTES(ndr, length*byte_mul);
646 if (ndr->flags & LIBNDR_FLAG_STR_NULLTERM) {
647 /* Explicitly ignore the return value here. An array that
648 * is not zero-terminated is considered a warning only, not fatal */
649 ndr_check_string_terminator(ndr, length, byte_mul);
652 ret = convert_string_talloc(ndr->current_mem_ctx,
654 ndr->data+ndr->offset,
656 discard_const_p(void *, var));
658 return ndr_pull_error(ndr, NDR_ERR_CHARCNV,
659 "Bad character conversion");
661 NDR_CHECK(ndr_pull_advance(ndr, length*byte_mul));
666 NTSTATUS ndr_push_charset(struct ndr_push *ndr, int ndr_flags, const char *var, uint32_t length, uint8_t byte_mul, int chset)
668 ssize_t ret, required;
670 required = byte_mul * length;
672 NDR_PUSH_NEED_BYTES(ndr, required);
673 ret = convert_string(CH_UNIX, chset,
675 ndr->data+ndr->offset, required);
677 return ndr_push_error(ndr, NDR_ERR_CHARCNV,
678 "Bad character conversion");
681 /* Make sure the remaining part of the string is filled with zeroes */
682 if (ret < required) {
683 memset(ndr->data+ndr->offset+ret, 0, required-ret);
686 ndr->offset += required;
691 /* Return number of elements in a string in the specified charset */
692 uint32_t ndr_charset_length(const void *var, int chset)
694 /* FIXME: Treat special chars special here, taking chset into account */
695 /* Also include 0 byte */
696 return strlen(var)+1;