2 Unix SMB/CIFS implementation.
3 Samba memory buffer functions
4 Copyright (C) Andrew Tridgell 1992-1997
5 Copyright (C) Luke Kenneth Casson Leighton 1996-1997
6 Copyright (C) Jeremy Allison 1999
7 Copyright (C) Andrew Bartlett 2003.
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.
27 #define DBGC_CLASS DBGC_RPC_PARSE
30 * Dump a prs to a file: from the current location through to the end.
32 void prs_dump(char *name, int v, prs_struct *ps)
34 prs_dump_region(name, v, ps, ps->data_offset, ps->buffer_size);
38 * Dump from the start of the prs to the current location.
40 void prs_dump_before(char *name, int v, prs_struct *ps)
42 prs_dump_region(name, v, ps, 0, ps->data_offset);
46 * Dump everything from the start of the prs up to the current location.
48 void prs_dump_region(char *name, int v, prs_struct *ps,
49 int from_off, int to_off)
54 if (DEBUGLEVEL < 50) return;
57 slprintf(fname,sizeof(fname)-1, "/tmp/%s_%d.%d.prs", name, v, i);
59 slprintf(fname,sizeof(fname)-1, "/tmp/%s.%d.prs", name, i);
61 fd = open(fname, O_WRONLY|O_CREAT|O_EXCL, 0644);
62 if (fd != -1 || errno != EEXIST) break;
65 sz = write(fd, ps->data_p + from_off, to_off - from_off);
67 if ( (sz != to_off-from_off) || (i != 0) ) {
68 DEBUG(0,("Error writing/closing %s: %ld!=%ld %d\n", fname, (unsigned long)sz, (unsigned long)to_off-from_off, i ));
70 DEBUG(0,("created %s\n", fname));
75 /*******************************************************************
76 Debug output for parsing info
78 XXXX side-effect of this function is to increase the debug depth XXXX.
80 ********************************************************************/
82 void prs_debug(prs_struct *ps, int depth, const char *desc, const char *fn_name)
84 DEBUG(5+depth, ("%s%06x %s %s\n", tab_depth(depth), ps->data_offset, fn_name, desc));
88 * Initialise an expandable parse structure.
90 * @param size Initial buffer size. If >0, a new buffer will be
91 * created with malloc().
93 * @return False if allocation fails, otherwise True.
96 BOOL prs_init(prs_struct *ps, uint32 size, TALLOC_CTX *ctx, BOOL io)
100 ps->bigendian_data = RPC_LITTLE_ENDIAN;
101 ps->align = RPC_PARSE_ALIGN;
102 ps->is_dynamic = False;
109 ps->buffer_size = size;
110 if((ps->data_p = (char *)SMB_MALLOC((size_t)size)) == NULL) {
111 DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size));
114 memset(ps->data_p, '\0', (size_t)size);
115 ps->is_dynamic = True; /* We own this memory. */
116 } else if (MARSHALLING(ps)) {
117 /* If size is zero and we're marshalling we should allocate memory on demand. */
118 ps->is_dynamic = True;
124 /*******************************************************************
125 Delete the memory in a parse structure - if we own it.
126 ********************************************************************/
128 void prs_mem_free(prs_struct *ps)
131 SAFE_FREE(ps->data_p);
132 ps->is_dynamic = False;
137 /*******************************************************************
138 Clear the memory in a parse structure.
139 ********************************************************************/
141 void prs_mem_clear(prs_struct *ps)
144 memset(ps->data_p, '\0', (size_t)ps->buffer_size);
147 /*******************************************************************
148 Allocate memory when unmarshalling... Always zero clears.
149 ********************************************************************/
151 #if defined(PARANOID_MALLOC_CHECKER)
152 char *prs_alloc_mem_(prs_struct *ps, size_t size, unsigned int count)
154 char *prs_alloc_mem(prs_struct *ps, size_t size, unsigned int count)
160 /* We can't call the type-safe version here. */
161 ret = _talloc_zero_array(ps->mem_ctx, size, count, "parse_prs");
166 /*******************************************************************
167 Return the current talloc context we're using.
168 ********************************************************************/
170 TALLOC_CTX *prs_get_mem_context(prs_struct *ps)
175 /*******************************************************************
176 Hand some already allocated memory to a prs_struct.
177 ********************************************************************/
179 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, BOOL is_dynamic)
181 ps->is_dynamic = is_dynamic;
183 ps->buffer_size = size;
186 /*******************************************************************
187 Take some memory back from a prs_struct.
188 ********************************************************************/
190 char *prs_take_memory(prs_struct *ps, uint32 *psize)
192 char *ret = ps->data_p;
194 *psize = ps->buffer_size;
195 ps->is_dynamic = False;
200 /*******************************************************************
201 Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
202 ********************************************************************/
204 BOOL prs_set_buffer_size(prs_struct *ps, uint32 newsize)
206 if (newsize > ps->buffer_size)
207 return prs_force_grow(ps, newsize - ps->buffer_size);
209 if (newsize < ps->buffer_size) {
210 char *new_data_p = SMB_REALLOC(ps->data_p, newsize);
211 /* if newsize is zero, Realloc acts like free() & returns NULL*/
212 if (new_data_p == NULL && newsize != 0) {
213 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
214 (unsigned int)newsize));
215 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno)));
218 ps->data_p = new_data_p;
219 ps->buffer_size = newsize;
225 /*******************************************************************
226 Attempt, if needed, to grow a data buffer.
227 Also depends on the data stream mode (io).
228 ********************************************************************/
230 BOOL prs_grow(prs_struct *ps, uint32 extra_space)
235 ps->grow_size = MAX(ps->grow_size, ps->data_offset + extra_space);
237 if(ps->data_offset + extra_space <= ps->buffer_size)
241 * We cannot grow the buffer if we're not reading
242 * into the prs_struct, or if we don't own the memory.
245 if(UNMARSHALLING(ps) || !ps->is_dynamic) {
246 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
247 (unsigned int)extra_space));
252 * Decide how much extra space we really need.
255 extra_space -= (ps->buffer_size - ps->data_offset);
256 if(ps->buffer_size == 0) {
258 * Ensure we have at least a PDU's length, or extra_space, whichever
262 new_size = MAX(RPC_MAX_PDU_FRAG_LEN,extra_space);
264 if((new_data = SMB_MALLOC(new_size)) == NULL) {
265 DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size));
268 memset(new_data, '\0', (size_t)new_size );
271 * If the current buffer size is bigger than the space needed, just
272 * double it, else add extra_space.
274 new_size = MAX(ps->buffer_size*2, ps->buffer_size + extra_space);
276 if ((new_data = SMB_REALLOC(ps->data_p, new_size)) == NULL) {
277 DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
278 (unsigned int)new_size));
282 memset(&new_data[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
284 ps->buffer_size = new_size;
285 ps->data_p = new_data;
290 /*******************************************************************
291 Attempt to force a data buffer to grow by len bytes.
292 This is only used when appending more data onto a prs_struct
293 when reading an rpc reply, before unmarshalling it.
294 ********************************************************************/
296 BOOL prs_force_grow(prs_struct *ps, uint32 extra_space)
298 uint32 new_size = ps->buffer_size + extra_space;
301 if(!UNMARSHALLING(ps) || !ps->is_dynamic) {
302 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
303 (unsigned int)extra_space));
307 if((new_data = SMB_REALLOC(ps->data_p, new_size)) == NULL) {
308 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
309 (unsigned int)new_size));
313 memset(&new_data[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
315 ps->buffer_size = new_size;
316 ps->data_p = new_data;
321 /*******************************************************************
322 Get the data pointer (external interface).
323 ********************************************************************/
325 char *prs_data_p(prs_struct *ps)
330 /*******************************************************************
331 Get the current data size (external interface).
332 ********************************************************************/
334 uint32 prs_data_size(prs_struct *ps)
336 return ps->buffer_size;
339 /*******************************************************************
340 Fetch the current offset (external interface).
341 ********************************************************************/
343 uint32 prs_offset(prs_struct *ps)
345 return ps->data_offset;
348 /*******************************************************************
349 Set the current offset (external interface).
350 ********************************************************************/
352 BOOL prs_set_offset(prs_struct *ps, uint32 offset)
354 if(offset <= ps->data_offset) {
355 ps->data_offset = offset;
359 if(!prs_grow(ps, offset - ps->data_offset))
362 ps->data_offset = offset;
366 /*******************************************************************
367 Append the data from one parse_struct into another.
368 ********************************************************************/
370 BOOL prs_append_prs_data(prs_struct *dst, prs_struct *src)
372 if (prs_offset(src) == 0)
375 if(!prs_grow(dst, prs_offset(src)))
378 memcpy(&dst->data_p[dst->data_offset], src->data_p, (size_t)prs_offset(src));
379 dst->data_offset += prs_offset(src);
384 /*******************************************************************
385 Append some data from one parse_struct into another.
386 ********************************************************************/
388 BOOL prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start, uint32 len)
393 if(!prs_grow(dst, len))
396 memcpy(&dst->data_p[dst->data_offset], src->data_p + start, (size_t)len);
397 dst->data_offset += len;
402 /*******************************************************************
403 Append the data from a buffer into a parse_struct.
404 ********************************************************************/
406 BOOL prs_copy_data_in(prs_struct *dst, const char *src, uint32 len)
411 if(!prs_grow(dst, len))
414 memcpy(&dst->data_p[dst->data_offset], src, (size_t)len);
415 dst->data_offset += len;
420 /*******************************************************************
421 Copy some data from a parse_struct into a buffer.
422 ********************************************************************/
424 BOOL prs_copy_data_out(char *dst, prs_struct *src, uint32 len)
429 if(!prs_mem_get(src, len))
432 memcpy(dst, &src->data_p[src->data_offset], (size_t)len);
433 src->data_offset += len;
438 /*******************************************************************
439 Copy all the data from a parse_struct into a buffer.
440 ********************************************************************/
442 BOOL prs_copy_all_data_out(char *dst, prs_struct *src)
444 uint32 len = prs_offset(src);
449 prs_set_offset(src, 0);
450 return prs_copy_data_out(dst, src, len);
453 /*******************************************************************
454 Set the data as X-endian (external interface).
455 ********************************************************************/
457 void prs_set_endian_data(prs_struct *ps, BOOL endian)
459 ps->bigendian_data = endian;
462 /*******************************************************************
463 Align a the data_len to a multiple of align bytes - filling with
465 ********************************************************************/
467 BOOL prs_align(prs_struct *ps)
469 uint32 mod = ps->data_offset & (ps->align-1);
471 if (ps->align != 0 && mod != 0) {
472 uint32 extra_space = (ps->align - mod);
473 if(!prs_grow(ps, extra_space))
475 memset(&ps->data_p[ps->data_offset], '\0', (size_t)extra_space);
476 ps->data_offset += extra_space;
482 /******************************************************************
483 Align on a 2 byte boundary
484 *****************************************************************/
486 BOOL prs_align_uint16(prs_struct *ps)
489 uint8 old_align = ps->align;
493 ps->align = old_align;
498 /******************************************************************
499 Align on a 8 byte boundary
500 *****************************************************************/
502 BOOL prs_align_uint64(prs_struct *ps)
505 uint8 old_align = ps->align;
509 ps->align = old_align;
514 /*******************************************************************
515 Align only if required (for the unistr2 string mainly)
516 ********************************************************************/
518 BOOL prs_align_needed(prs_struct *ps, uint32 needed)
523 return prs_align(ps);
526 /*******************************************************************
527 Ensure we can read/write to a given offset.
528 ********************************************************************/
530 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
532 if(UNMARSHALLING(ps)) {
534 * If reading, ensure that we can read the requested size item.
536 if (ps->data_offset + extra_size > ps->buffer_size) {
537 DEBUG(0,("prs_mem_get: reading data of size %u would overrun "
538 "buffer by %u bytes.\n",
539 (unsigned int)extra_size,
540 (unsigned int)(ps->data_offset + extra_size - ps->buffer_size) ));
545 * Writing - grow the buffer if needed.
547 if(!prs_grow(ps, extra_size))
550 return &ps->data_p[ps->data_offset];
553 /*******************************************************************
554 Change the struct type.
555 ********************************************************************/
557 void prs_switch_type(prs_struct *ps, BOOL io)
559 if ((ps->io ^ io) == True)
563 /*******************************************************************
564 Force a prs_struct to be dynamic even when it's size is 0.
565 ********************************************************************/
567 void prs_force_dynamic(prs_struct *ps)
572 /*******************************************************************
573 Associate a session key with a parse struct.
574 ********************************************************************/
576 void prs_set_session_key(prs_struct *ps, const char sess_key[16])
578 ps->sess_key = sess_key;
581 /*******************************************************************
583 ********************************************************************/
585 BOOL prs_uint8(const char *name, prs_struct *ps, int depth, uint8 *data8)
587 char *q = prs_mem_get(ps, 1);
591 if (UNMARSHALLING(ps))
596 DEBUG(5,("%s%04x %s: %02x\n", tab_depth(depth), ps->data_offset, name, *data8));
598 ps->data_offset += 1;
603 /*******************************************************************
604 Stream a uint16* (allocate memory if unmarshalling)
605 ********************************************************************/
607 BOOL prs_pointer( const char *name, prs_struct *ps, int depth,
608 void **data, size_t data_size,
609 BOOL(*prs_fn)(const char*, prs_struct*, int, void*) )
613 /* output f000baaa to stream if the pointer is non-zero. */
615 data_p = *data ? 0xf000baaa : 0;
617 if ( !prs_uint32("ptr", ps, depth, &data_p ))
620 /* we're done if there is no data */
625 if (UNMARSHALLING(ps)) {
626 if ( !(*data = PRS_ALLOC_MEM_VOID(ps, data_size)) )
630 return prs_fn(name, ps, depth, *data);
634 /*******************************************************************
636 ********************************************************************/
638 BOOL prs_uint16(const char *name, prs_struct *ps, int depth, uint16 *data16)
640 char *q = prs_mem_get(ps, sizeof(uint16));
644 if (UNMARSHALLING(ps)) {
645 if (ps->bigendian_data)
646 *data16 = RSVAL(q,0);
650 if (ps->bigendian_data)
656 DEBUG(5,("%s%04x %s: %04x\n", tab_depth(depth), ps->data_offset, name, *data16));
658 ps->data_offset += sizeof(uint16);
663 /*******************************************************************
665 ********************************************************************/
667 BOOL prs_uint32(const char *name, prs_struct *ps, int depth, uint32 *data32)
669 char *q = prs_mem_get(ps, sizeof(uint32));
673 if (UNMARSHALLING(ps)) {
674 if (ps->bigendian_data)
675 *data32 = RIVAL(q,0);
679 if (ps->bigendian_data)
685 DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth), ps->data_offset, name, *data32));
687 ps->data_offset += sizeof(uint32);
692 /*******************************************************************
694 ********************************************************************/
696 BOOL prs_ntstatus(const char *name, prs_struct *ps, int depth, NTSTATUS *status)
698 char *q = prs_mem_get(ps, sizeof(uint32));
702 if (UNMARSHALLING(ps)) {
703 if (ps->bigendian_data)
704 *status = NT_STATUS(RIVAL(q,0));
706 *status = NT_STATUS(IVAL(q,0));
708 if (ps->bigendian_data)
709 RSIVAL(q,0,NT_STATUS_V(*status));
711 SIVAL(q,0,NT_STATUS_V(*status));
714 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name,
715 nt_errstr(*status)));
717 ps->data_offset += sizeof(uint32);
722 /*******************************************************************
724 ********************************************************************/
726 BOOL prs_werror(const char *name, prs_struct *ps, int depth, WERROR *status)
728 char *q = prs_mem_get(ps, sizeof(uint32));
732 if (UNMARSHALLING(ps)) {
733 if (ps->bigendian_data)
734 *status = W_ERROR(RIVAL(q,0));
736 *status = W_ERROR(IVAL(q,0));
738 if (ps->bigendian_data)
739 RSIVAL(q,0,W_ERROR_V(*status));
741 SIVAL(q,0,W_ERROR_V(*status));
744 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name,
745 dos_errstr(*status)));
747 ps->data_offset += sizeof(uint32);
753 /******************************************************************
754 Stream an array of uint8s. Length is number of uint8s.
755 ********************************************************************/
757 BOOL prs_uint8s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
760 char *q = prs_mem_get(ps, len);
764 if (UNMARSHALLING(ps)) {
765 for (i = 0; i < len; i++)
766 data8s[i] = CVAL(q,i);
768 for (i = 0; i < len; i++)
769 SCVAL(q, i, data8s[i]);
772 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset ,name));
774 print_asc(5, (unsigned char*)data8s, len);
776 for (i = 0; i < len; i++)
777 DEBUG(5,("%02x ", data8s[i]));
781 ps->data_offset += len;
786 /******************************************************************
787 Stream an array of uint16s. Length is number of uint16s.
788 ********************************************************************/
790 BOOL prs_uint16s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
793 char *q = prs_mem_get(ps, len * sizeof(uint16));
797 if (UNMARSHALLING(ps)) {
798 if (ps->bigendian_data) {
799 for (i = 0; i < len; i++)
800 data16s[i] = RSVAL(q, 2*i);
802 for (i = 0; i < len; i++)
803 data16s[i] = SVAL(q, 2*i);
806 if (ps->bigendian_data) {
807 for (i = 0; i < len; i++)
808 RSSVAL(q, 2*i, data16s[i]);
810 for (i = 0; i < len; i++)
811 SSVAL(q, 2*i, data16s[i]);
815 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
817 print_asc(5, (unsigned char*)data16s, 2*len);
819 for (i = 0; i < len; i++)
820 DEBUG(5,("%04x ", data16s[i]));
824 ps->data_offset += (len * sizeof(uint16));
829 /******************************************************************
830 Start using a function for streaming unicode chars. If unmarshalling,
831 output must be little-endian, if marshalling, input must be little-endian.
832 ********************************************************************/
834 static void dbg_rw_punival(BOOL charmode, const char *name, int depth, prs_struct *ps,
835 char *in_buf, char *out_buf, int len)
839 if (UNMARSHALLING(ps)) {
840 if (ps->bigendian_data) {
841 for (i = 0; i < len; i++)
842 SSVAL(out_buf,2*i,RSVAL(in_buf, 2*i));
844 for (i = 0; i < len; i++)
845 SSVAL(out_buf, 2*i, SVAL(in_buf, 2*i));
848 if (ps->bigendian_data) {
849 for (i = 0; i < len; i++)
850 RSSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
852 for (i = 0; i < len; i++)
853 SSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
857 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
859 print_asc(5, (unsigned char*)out_buf, 2*len);
861 for (i = 0; i < len; i++)
862 DEBUG(5,("%04x ", out_buf[i]));
867 /******************************************************************
868 Stream a unistr. Always little endian.
869 ********************************************************************/
871 BOOL prs_uint16uni(BOOL charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
873 char *q = prs_mem_get(ps, len * sizeof(uint16));
877 dbg_rw_punival(charmode, name, depth, ps, q, (char *)data16s, len);
878 ps->data_offset += (len * sizeof(uint16));
883 /******************************************************************
884 Stream an array of uint32s. Length is number of uint32s.
885 ********************************************************************/
887 BOOL prs_uint32s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
890 char *q = prs_mem_get(ps, len * sizeof(uint32));
894 if (UNMARSHALLING(ps)) {
895 if (ps->bigendian_data) {
896 for (i = 0; i < len; i++)
897 data32s[i] = RIVAL(q, 4*i);
899 for (i = 0; i < len; i++)
900 data32s[i] = IVAL(q, 4*i);
903 if (ps->bigendian_data) {
904 for (i = 0; i < len; i++)
905 RSIVAL(q, 4*i, data32s[i]);
907 for (i = 0; i < len; i++)
908 SIVAL(q, 4*i, data32s[i]);
912 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
914 print_asc(5, (unsigned char*)data32s, 4*len);
916 for (i = 0; i < len; i++)
917 DEBUG(5,("%08x ", data32s[i]));
921 ps->data_offset += (len * sizeof(uint32));
926 /******************************************************************
927 Stream an array of unicode string, length/buffer specified separately,
928 in uint16 chars. The unicode string is already in little-endian format.
929 ********************************************************************/
931 BOOL prs_buffer5(BOOL charmode, const char *name, prs_struct *ps, int depth, BUFFER5 *str)
934 char *q = prs_mem_get(ps, str->buf_len * sizeof(uint16));
938 if (UNMARSHALLING(ps)) {
939 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->buf_len);
940 if (str->buffer == NULL)
944 /* If the string is empty, we don't have anything to stream */
948 p = (char *)str->buffer;
950 dbg_rw_punival(charmode, name, depth, ps, q, p, str->buf_len);
952 ps->data_offset += (str->buf_len * sizeof(uint16));
957 /******************************************************************
958 Stream a "not" unicode string, length/buffer specified separately,
959 in byte chars. String is in little-endian format.
960 ********************************************************************/
962 BOOL prs_regval_buffer(BOOL charmode, const char *name, prs_struct *ps, int depth, REGVAL_BUFFER *buf)
965 char *q = prs_mem_get(ps, buf->buf_len);
969 if (UNMARSHALLING(ps)) {
970 if (buf->buf_len > buf->buf_max_len) {
973 if ( buf->buf_max_len ) {
974 buf->buffer = PRS_ALLOC_MEM(ps, uint16, buf->buf_max_len);
975 if ( buf->buffer == NULL )
980 p = (char *)buf->buffer;
982 dbg_rw_punival(charmode, name, depth, ps, q, p, buf->buf_len/2);
983 ps->data_offset += buf->buf_len;
988 /******************************************************************
989 Stream a string, length/buffer specified separately,
991 ********************************************************************/
993 BOOL prs_string2(BOOL charmode, const char *name, prs_struct *ps, int depth, STRING2 *str)
996 char *q = prs_mem_get(ps, str->str_str_len);
1000 if (UNMARSHALLING(ps)) {
1001 if (str->str_str_len > str->str_max_len) {
1004 str->buffer = PRS_ALLOC_MEM(ps,unsigned char, str->str_max_len);
1005 if (str->buffer == NULL)
1009 if (UNMARSHALLING(ps)) {
1010 for (i = 0; i < str->str_str_len; i++)
1011 str->buffer[i] = CVAL(q,i);
1013 for (i = 0; i < str->str_str_len; i++)
1014 SCVAL(q, i, str->buffer[i]);
1017 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1019 print_asc(5, (unsigned char*)str->buffer, str->str_str_len);
1021 for (i = 0; i < str->str_str_len; i++)
1022 DEBUG(5,("%02x ", str->buffer[i]));
1026 ps->data_offset += str->str_str_len;
1031 /******************************************************************
1032 Stream a unicode string, length/buffer specified separately,
1033 in uint16 chars. The unicode string is already in little-endian format.
1034 ********************************************************************/
1036 BOOL prs_unistr2(BOOL charmode, const char *name, prs_struct *ps, int depth, UNISTR2 *str)
1039 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1043 /* If the string is empty, we don't have anything to stream */
1044 if (str->uni_str_len==0)
1047 if (UNMARSHALLING(ps)) {
1048 if (str->uni_str_len > str->uni_max_len) {
1051 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_max_len);
1052 if (str->buffer == NULL)
1056 p = (char *)str->buffer;
1058 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1060 ps->data_offset += (str->uni_str_len * sizeof(uint16));
1065 /******************************************************************
1066 Stream a unicode string, length/buffer specified separately,
1067 in uint16 chars. The unicode string is already in little-endian format.
1068 ********************************************************************/
1070 BOOL prs_unistr3(BOOL charmode, const char *name, UNISTR3 *str, prs_struct *ps, int depth)
1073 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1077 if (UNMARSHALLING(ps)) {
1078 str->str.buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_str_len);
1079 if (str->str.buffer == NULL)
1083 p = (char *)str->str.buffer;
1085 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1086 ps->data_offset += (str->uni_str_len * sizeof(uint16));
1091 /*******************************************************************
1092 Stream a unicode null-terminated string. As the string is already
1093 in little-endian format then do it as a stream of bytes.
1094 ********************************************************************/
1096 BOOL prs_unistr(const char *name, prs_struct *ps, int depth, UNISTR *str)
1098 unsigned int len = 0;
1099 unsigned char *p = (unsigned char *)str->buffer;
1105 if (MARSHALLING(ps)) {
1107 for(len = 0; str->buffer[len] != 0; len++)
1110 q = prs_mem_get(ps, (len+1)*2);
1116 for(len = 0; str->buffer[len] != 0; len++) {
1117 if(ps->bigendian_data) {
1118 /* swap bytes - p is little endian, q is big endian. */
1134 * even if the string is 'empty' (only an \0 char)
1135 * at this point the leading \0 hasn't been parsed.
1145 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1146 print_asc(5, (unsigned char*)start, 2*len);
1149 else { /* unmarshalling */
1151 uint32 alloc_len = 0;
1152 q = ps->data_p + prs_offset(ps);
1155 * Work out how much space we need and talloc it.
1157 max_len = (ps->buffer_size - ps->data_offset)/sizeof(uint16);
1159 /* the test of the value of *ptr helps to catch the circumstance
1160 where we have an emtpty (non-existent) string in the buffer */
1161 for ( ptr = (uint16 *)q; *ptr++ && (alloc_len <= max_len); alloc_len++)
1165 if (alloc_len < max_len)
1168 /* should we allocate anything at all? */
1169 str->buffer = PRS_ALLOC_MEM(ps,uint16,alloc_len);
1170 if ((str->buffer == NULL) && (alloc_len > 0))
1173 p = (unsigned char *)str->buffer;
1176 /* the (len < alloc_len) test is to prevent us from overwriting
1177 memory that is not ours...if we get that far, we have a non-null
1178 terminated string in the buffer and have messed up somewhere */
1179 while ((len < alloc_len) && (*(uint16 *)q != 0)) {
1180 if(ps->bigendian_data)
1182 /* swap bytes - q is big endian, p is little endian. */
1183 p[0] = (unsigned char)q[1];
1184 p[1] = (unsigned char)q[0];
1189 p[0] = (unsigned char)q[0];
1190 p[1] = (unsigned char)q[1];
1197 if (len < alloc_len) {
1198 /* NULL terminate the UNISTR */
1199 str->buffer[len++] = '\0';
1202 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1203 print_asc(5, (unsigned char*)str->buffer, 2*len);
1207 /* set the offset in the prs_struct; 'len' points to the
1208 terminiating NULL in the UNISTR so we need to go one more
1210 ps->data_offset += (len)*2;
1216 /*******************************************************************
1217 Stream a null-terminated string. len is strlen, and therefore does
1218 not include the null-termination character.
1219 ********************************************************************/
1221 BOOL prs_string(const char *name, prs_struct *ps, int depth, char *str, int max_buf_size)
1227 if (UNMARSHALLING(ps))
1228 len = strlen(&ps->data_p[ps->data_offset]);
1232 len = MIN(len, (max_buf_size-1));
1234 q = prs_mem_get(ps, len+1);
1238 for(i = 0; i < len; i++) {
1239 if (UNMARSHALLING(ps))
1245 /* The terminating null. */
1248 if (MARSHALLING(ps)) {
1252 ps->data_offset += len+1;
1254 dump_data(5+depth, q, len);
1259 BOOL prs_string_alloc(const char *name, prs_struct *ps, int depth,
1265 if (UNMARSHALLING(ps))
1266 len = strlen(&ps->data_p[ps->data_offset]);
1270 tmp_str = PRS_ALLOC_MEM(ps, char, len+1);
1272 if (tmp_str == NULL)
1275 if (MARSHALLING(ps))
1276 strncpy(tmp_str, *str, len);
1278 if (!prs_string(name, ps, depth, tmp_str, len+1))
1285 /*******************************************************************
1286 prs_uint16 wrapper. Call this and it sets up a pointer to where the
1287 uint16 should be stored, or gets the size if reading.
1288 ********************************************************************/
1290 BOOL prs_uint16_pre(const char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
1292 *offset = ps->data_offset;
1293 if (UNMARSHALLING(ps)) {
1295 return prs_uint16(name, ps, depth, data16);
1297 char *q = prs_mem_get(ps, sizeof(uint16));
1300 ps->data_offset += sizeof(uint16);
1305 /*******************************************************************
1306 prs_uint16 wrapper. call this and it retrospectively stores the size.
1307 does nothing on reading, as that is already handled by ...._pre()
1308 ********************************************************************/
1310 BOOL prs_uint16_post(const char *name, prs_struct *ps, int depth, uint16 *data16,
1311 uint32 ptr_uint16, uint32 start_offset)
1313 if (MARSHALLING(ps)) {
1315 * Writing - temporarily move the offset pointer.
1317 uint16 data_size = ps->data_offset - start_offset;
1318 uint32 old_offset = ps->data_offset;
1320 ps->data_offset = ptr_uint16;
1321 if(!prs_uint16(name, ps, depth, &data_size)) {
1322 ps->data_offset = old_offset;
1325 ps->data_offset = old_offset;
1327 ps->data_offset = start_offset + (uint32)(*data16);
1332 /*******************************************************************
1333 prs_uint32 wrapper. Call this and it sets up a pointer to where the
1334 uint32 should be stored, or gets the size if reading.
1335 ********************************************************************/
1337 BOOL prs_uint32_pre(const char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
1339 *offset = ps->data_offset;
1340 if (UNMARSHALLING(ps) && (data32 != NULL)) {
1342 return prs_uint32(name, ps, depth, data32);
1344 ps->data_offset += sizeof(uint32);
1349 /*******************************************************************
1350 prs_uint32 wrapper. call this and it retrospectively stores the size.
1351 does nothing on reading, as that is already handled by ...._pre()
1352 ********************************************************************/
1354 BOOL prs_uint32_post(const char *name, prs_struct *ps, int depth, uint32 *data32,
1355 uint32 ptr_uint32, uint32 data_size)
1357 if (MARSHALLING(ps)) {
1359 * Writing - temporarily move the offset pointer.
1361 uint32 old_offset = ps->data_offset;
1362 ps->data_offset = ptr_uint32;
1363 if(!prs_uint32(name, ps, depth, &data_size)) {
1364 ps->data_offset = old_offset;
1367 ps->data_offset = old_offset;
1372 /* useful function to store a structure in rpc wire format */
1373 int tdb_prs_store(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
1375 TDB_DATA kbuf, dbuf;
1377 kbuf.dsize = strlen(keystr)+1;
1378 dbuf.dptr = ps->data_p;
1379 dbuf.dsize = prs_offset(ps);
1380 return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE);
1383 /* useful function to fetch a structure into rpc wire format */
1384 int tdb_prs_fetch(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps, TALLOC_CTX *mem_ctx)
1386 TDB_DATA kbuf, dbuf;
1388 kbuf.dsize = strlen(keystr)+1;
1390 dbuf = tdb_fetch(tdb, kbuf);
1394 prs_init(ps, 0, mem_ctx, UNMARSHALL);
1395 prs_give_memory(ps, dbuf.dptr, dbuf.dsize, True);
1400 /*******************************************************************
1402 ********************************************************************/
1404 BOOL prs_hash1(prs_struct *ps, uint32 offset, int len)
1411 #ifdef DEBUG_PASSWORD
1412 DEBUG(100, ("prs_hash1\n"));
1413 dump_data(100, ps->sess_key, 16);
1414 dump_data(100, q, len);
1416 SamOEMhash((uchar *) q, ps->sess_key, len);
1418 #ifdef DEBUG_PASSWORD
1419 dump_data(100, q, len);
1425 /*******************************************************************
1426 Create a digest over the entire packet (including the data), and
1427 MD5 it with the session key.
1428 ********************************************************************/
1430 static void schannel_digest(struct schannel_auth_struct *a,
1431 enum pipe_auth_level auth_level,
1432 RPC_AUTH_SCHANNEL_CHK * verf,
1433 char *data, size_t data_len,
1434 uchar digest_final[16])
1436 uchar whole_packet_digest[16];
1437 static uchar zeros[4];
1438 struct MD5Context ctx3;
1440 /* verfiy the signature on the packet by MD5 over various bits */
1442 /* use our sequence number, which ensures the packet is not
1444 MD5Update(&ctx3, zeros, sizeof(zeros));
1445 MD5Update(&ctx3, verf->sig, sizeof(verf->sig));
1446 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1447 MD5Update(&ctx3, verf->confounder, sizeof(verf->confounder));
1449 MD5Update(&ctx3, (const unsigned char *)data, data_len);
1450 MD5Final(whole_packet_digest, &ctx3);
1451 dump_data_pw("whole_packet_digest:\n", whole_packet_digest, sizeof(whole_packet_digest));
1453 /* MD5 this result and the session key, to prove that
1454 only a valid client could had produced this */
1455 hmac_md5(a->sess_key, whole_packet_digest, sizeof(whole_packet_digest), digest_final);
1458 /*******************************************************************
1459 Calculate the key with which to encode the data payload
1460 ********************************************************************/
1462 static void schannel_get_sealing_key(struct schannel_auth_struct *a,
1463 RPC_AUTH_SCHANNEL_CHK *verf,
1464 uchar sealing_key[16])
1466 static uchar zeros[4];
1471 for (i = 0; i < sizeof(sess_kf0); i++) {
1472 sess_kf0[i] = a->sess_key[i] ^ 0xf0;
1475 dump_data_pw("sess_kf0:\n", sess_kf0, sizeof(sess_kf0));
1477 /* MD5 of sess_kf0 and 4 zero bytes */
1478 hmac_md5(sess_kf0, zeros, 0x4, digest2);
1479 dump_data_pw("digest2:\n", digest2, sizeof(digest2));
1481 /* MD5 of the above result, plus 8 bytes of sequence number */
1482 hmac_md5(digest2, verf->seq_num, sizeof(verf->seq_num), sealing_key);
1483 dump_data_pw("sealing_key:\n", sealing_key, 16);
1486 /*******************************************************************
1487 Encode or Decode the sequence number (which is symmetric)
1488 ********************************************************************/
1490 static void schannel_deal_with_seq_num(struct schannel_auth_struct *a,
1491 RPC_AUTH_SCHANNEL_CHK *verf)
1493 static uchar zeros[4];
1494 uchar sequence_key[16];
1497 hmac_md5(a->sess_key, zeros, sizeof(zeros), digest1);
1498 dump_data_pw("(sequence key) digest1:\n", digest1, sizeof(digest1));
1500 hmac_md5(digest1, verf->packet_digest, 8, sequence_key);
1502 dump_data_pw("sequence_key:\n", sequence_key, sizeof(sequence_key));
1504 dump_data_pw("seq_num (before):\n", verf->seq_num, sizeof(verf->seq_num));
1505 SamOEMhash(verf->seq_num, sequence_key, 8);
1506 dump_data_pw("seq_num (after):\n", verf->seq_num, sizeof(verf->seq_num));
1509 /*******************************************************************
1510 creates an RPC_AUTH_SCHANNEL_CHK structure.
1511 ********************************************************************/
1513 static BOOL init_rpc_auth_schannel_chk(RPC_AUTH_SCHANNEL_CHK * chk,
1515 const uchar packet_digest[8],
1516 const uchar seq_num[8], const uchar confounder[8])
1521 memcpy(chk->sig, sig, sizeof(chk->sig));
1522 memcpy(chk->packet_digest, packet_digest, sizeof(chk->packet_digest));
1523 memcpy(chk->seq_num, seq_num, sizeof(chk->seq_num));
1524 memcpy(chk->confounder, confounder, sizeof(chk->confounder));
1529 /*******************************************************************
1530 Encode a blob of data using the schannel alogrithm, also produceing
1531 a checksum over the original data. We currently only support
1532 signing and sealing togeather - the signing-only code is close, but not
1533 quite compatible with what MS does.
1534 ********************************************************************/
1536 void schannel_encode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1537 enum schannel_direction direction,
1538 RPC_AUTH_SCHANNEL_CHK * verf,
1539 char *data, size_t data_len)
1541 uchar digest_final[16];
1542 uchar confounder[8];
1544 static const uchar nullbytes[8];
1546 static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1547 static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1548 const uchar *schannel_sig = NULL;
1550 DEBUG(10,("SCHANNEL: schannel_encode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1552 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1553 schannel_sig = schannel_seal_sig;
1555 schannel_sig = schannel_sign_sig;
1558 /* fill the 'confounder' with random data */
1559 generate_random_buffer(confounder, sizeof(confounder));
1561 dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1563 RSIVAL(seq_num, 0, a->seq_num);
1565 switch (direction) {
1566 case SENDER_IS_INITIATOR:
1567 SIVAL(seq_num, 4, 0x80);
1569 case SENDER_IS_ACCEPTOR:
1570 SIVAL(seq_num, 4, 0x0);
1574 dump_data_pw("verf->seq_num:\n", seq_num, sizeof(verf->seq_num));
1576 init_rpc_auth_schannel_chk(verf, schannel_sig, nullbytes,
1577 seq_num, confounder);
1579 /* produce a digest of the packet to prove it's legit (before we seal it) */
1580 schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1581 memcpy(verf->packet_digest, digest_final, sizeof(verf->packet_digest));
1583 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1584 uchar sealing_key[16];
1586 /* get the key to encode the data with */
1587 schannel_get_sealing_key(a, verf, sealing_key);
1589 /* encode the verification data */
1590 dump_data_pw("verf->confounder:\n", verf->confounder, sizeof(verf->confounder));
1591 SamOEMhash(verf->confounder, sealing_key, 8);
1593 dump_data_pw("verf->confounder_enc:\n", verf->confounder, sizeof(verf->confounder));
1595 /* encode the packet payload */
1596 dump_data_pw("data:\n", (const unsigned char *)data, data_len);
1597 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1598 dump_data_pw("data_enc:\n", (const unsigned char *)data, data_len);
1601 /* encode the sequence number (key based on packet digest) */
1602 /* needs to be done after the sealing, as the original version
1603 is used in the sealing stuff... */
1604 schannel_deal_with_seq_num(a, verf);
1609 /*******************************************************************
1610 Decode a blob of data using the schannel alogrithm, also verifiying
1611 a checksum over the original data. We currently can verify signed messages,
1612 as well as decode sealed messages
1613 ********************************************************************/
1615 BOOL schannel_decode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1616 enum schannel_direction direction,
1617 RPC_AUTH_SCHANNEL_CHK * verf, char *data, size_t data_len)
1619 uchar digest_final[16];
1621 static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1622 static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1623 const uchar *schannel_sig = NULL;
1627 DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1629 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1630 schannel_sig = schannel_seal_sig;
1632 schannel_sig = schannel_sign_sig;
1635 /* Create the expected sequence number for comparison */
1636 RSIVAL(seq_num, 0, a->seq_num);
1638 switch (direction) {
1639 case SENDER_IS_INITIATOR:
1640 SIVAL(seq_num, 4, 0x80);
1642 case SENDER_IS_ACCEPTOR:
1643 SIVAL(seq_num, 4, 0x0);
1647 DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1648 dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1650 dump_data_pw("seq_num:\n", seq_num, sizeof(seq_num));
1652 /* extract the sequence number (key based on supplied packet digest) */
1653 /* needs to be done before the sealing, as the original version
1654 is used in the sealing stuff... */
1655 schannel_deal_with_seq_num(a, verf);
1657 if (memcmp(verf->seq_num, seq_num, sizeof(seq_num))) {
1658 /* don't even bother with the below if the sequence number is out */
1659 /* The sequence number is MD5'ed with a key based on the whole-packet
1660 digest, as supplied by the client. We check that it's a valid
1661 checksum after the decode, below
1663 DEBUG(2, ("schannel_decode: FAILED: packet sequence number:\n"));
1664 dump_data(2, (const char*)verf->seq_num, sizeof(verf->seq_num));
1665 DEBUG(2, ("should be:\n"));
1666 dump_data(2, (const char*)seq_num, sizeof(seq_num));
1671 if (memcmp(verf->sig, schannel_sig, sizeof(verf->sig))) {
1672 /* Validate that the other end sent the expected header */
1673 DEBUG(2, ("schannel_decode: FAILED: packet header:\n"));
1674 dump_data(2, (const char*)verf->sig, sizeof(verf->sig));
1675 DEBUG(2, ("should be:\n"));
1676 dump_data(2, (const char*)schannel_sig, sizeof(schannel_sig));
1680 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1681 uchar sealing_key[16];
1683 /* get the key to extract the data with */
1684 schannel_get_sealing_key(a, verf, sealing_key);
1686 /* extract the verification data */
1687 dump_data_pw("verf->confounder:\n", verf->confounder,
1688 sizeof(verf->confounder));
1689 SamOEMhash(verf->confounder, sealing_key, 8);
1691 dump_data_pw("verf->confounder_dec:\n", verf->confounder,
1692 sizeof(verf->confounder));
1694 /* extract the packet payload */
1695 dump_data_pw("data :\n", (const unsigned char *)data, data_len);
1696 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1697 dump_data_pw("datadec:\n", (const unsigned char *)data, data_len);
1700 /* digest includes 'data' after unsealing */
1701 schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1703 dump_data_pw("Calculated digest:\n", digest_final,
1704 sizeof(digest_final));
1705 dump_data_pw("verf->packet_digest:\n", verf->packet_digest,
1706 sizeof(verf->packet_digest));
1708 /* compare - if the client got the same result as us, then
1709 it must know the session key */
1710 return (memcmp(digest_final, verf->packet_digest,
1711 sizeof(verf->packet_digest)) == 0);