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 on a specific byte boundary
516 *****************************************************************/
518 BOOL prs_align_custom(prs_struct *ps, uint8 boundary)
521 uint8 old_align = ps->align;
523 ps->align = boundary;
525 ps->align = old_align;
532 /*******************************************************************
533 Align only if required (for the unistr2 string mainly)
534 ********************************************************************/
536 BOOL prs_align_needed(prs_struct *ps, uint32 needed)
541 return prs_align(ps);
544 /*******************************************************************
545 Ensure we can read/write to a given offset.
546 ********************************************************************/
548 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
550 if(UNMARSHALLING(ps)) {
552 * If reading, ensure that we can read the requested size item.
554 if (ps->data_offset + extra_size > ps->buffer_size) {
555 DEBUG(0,("prs_mem_get: reading data of size %u would overrun "
556 "buffer by %u bytes.\n",
557 (unsigned int)extra_size,
558 (unsigned int)(ps->data_offset + extra_size - ps->buffer_size) ));
563 * Writing - grow the buffer if needed.
565 if(!prs_grow(ps, extra_size))
568 return &ps->data_p[ps->data_offset];
571 /*******************************************************************
572 Change the struct type.
573 ********************************************************************/
575 void prs_switch_type(prs_struct *ps, BOOL io)
577 if ((ps->io ^ io) == True)
581 /*******************************************************************
582 Force a prs_struct to be dynamic even when it's size is 0.
583 ********************************************************************/
585 void prs_force_dynamic(prs_struct *ps)
590 /*******************************************************************
591 Associate a session key with a parse struct.
592 ********************************************************************/
594 void prs_set_session_key(prs_struct *ps, const char sess_key[16])
596 ps->sess_key = sess_key;
599 /*******************************************************************
601 ********************************************************************/
603 BOOL prs_uint8(const char *name, prs_struct *ps, int depth, uint8 *data8)
605 char *q = prs_mem_get(ps, 1);
609 if (UNMARSHALLING(ps))
614 DEBUG(5,("%s%04x %s: %02x\n", tab_depth(depth), ps->data_offset, name, *data8));
616 ps->data_offset += 1;
621 /*******************************************************************
622 Stream a uint16* (allocate memory if unmarshalling)
623 ********************************************************************/
625 BOOL prs_pointer( const char *name, prs_struct *ps, int depth,
626 void **data, size_t data_size,
627 BOOL(*prs_fn)(const char*, prs_struct*, int, void*) )
631 /* output f000baaa to stream if the pointer is non-zero. */
633 data_p = *data ? 0xf000baaa : 0;
635 if ( !prs_uint32("ptr", ps, depth, &data_p ))
638 /* we're done if there is no data */
643 if (UNMARSHALLING(ps)) {
644 if ( !(*data = PRS_ALLOC_MEM_VOID(ps, data_size)) )
648 return prs_fn(name, ps, depth, *data);
652 /*******************************************************************
654 ********************************************************************/
656 BOOL prs_uint16(const char *name, prs_struct *ps, int depth, uint16 *data16)
658 char *q = prs_mem_get(ps, sizeof(uint16));
662 if (UNMARSHALLING(ps)) {
663 if (ps->bigendian_data)
664 *data16 = RSVAL(q,0);
668 if (ps->bigendian_data)
674 DEBUG(5,("%s%04x %s: %04x\n", tab_depth(depth), ps->data_offset, name, *data16));
676 ps->data_offset += sizeof(uint16);
681 /*******************************************************************
683 ********************************************************************/
685 BOOL prs_uint32(const char *name, prs_struct *ps, int depth, uint32 *data32)
687 char *q = prs_mem_get(ps, sizeof(uint32));
691 if (UNMARSHALLING(ps)) {
692 if (ps->bigendian_data)
693 *data32 = RIVAL(q,0);
697 if (ps->bigendian_data)
703 DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth), ps->data_offset, name, *data32));
705 ps->data_offset += sizeof(uint32);
710 /*******************************************************************
712 ********************************************************************/
714 BOOL prs_int32(const char *name, prs_struct *ps, int depth, int32 *data32)
716 char *q = prs_mem_get(ps, sizeof(int32));
720 if (UNMARSHALLING(ps)) {
721 if (ps->bigendian_data)
722 *data32 = RIVALS(q,0);
724 *data32 = IVALS(q,0);
726 if (ps->bigendian_data)
727 RSIVALS(q,0,*data32);
732 DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth), ps->data_offset, name, *data32));
734 ps->data_offset += sizeof(int32);
739 /*******************************************************************
741 ********************************************************************/
743 BOOL prs_ntstatus(const char *name, prs_struct *ps, int depth, NTSTATUS *status)
745 char *q = prs_mem_get(ps, sizeof(uint32));
749 if (UNMARSHALLING(ps)) {
750 if (ps->bigendian_data)
751 *status = NT_STATUS(RIVAL(q,0));
753 *status = NT_STATUS(IVAL(q,0));
755 if (ps->bigendian_data)
756 RSIVAL(q,0,NT_STATUS_V(*status));
758 SIVAL(q,0,NT_STATUS_V(*status));
761 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name,
762 nt_errstr(*status)));
764 ps->data_offset += sizeof(uint32);
769 /*******************************************************************
771 ********************************************************************/
773 BOOL prs_werror(const char *name, prs_struct *ps, int depth, WERROR *status)
775 char *q = prs_mem_get(ps, sizeof(uint32));
779 if (UNMARSHALLING(ps)) {
780 if (ps->bigendian_data)
781 *status = W_ERROR(RIVAL(q,0));
783 *status = W_ERROR(IVAL(q,0));
785 if (ps->bigendian_data)
786 RSIVAL(q,0,W_ERROR_V(*status));
788 SIVAL(q,0,W_ERROR_V(*status));
791 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name,
792 dos_errstr(*status)));
794 ps->data_offset += sizeof(uint32);
800 /******************************************************************
801 Stream an array of uint8s. Length is number of uint8s.
802 ********************************************************************/
804 BOOL prs_uint8s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
807 char *q = prs_mem_get(ps, len);
811 if (UNMARSHALLING(ps)) {
812 for (i = 0; i < len; i++)
813 data8s[i] = CVAL(q,i);
815 for (i = 0; i < len; i++)
816 SCVAL(q, i, data8s[i]);
819 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset ,name));
821 print_asc(5, (unsigned char*)data8s, len);
823 for (i = 0; i < len; i++)
824 DEBUG(5,("%02x ", data8s[i]));
828 ps->data_offset += len;
833 /******************************************************************
834 Stream an array of uint16s. Length is number of uint16s.
835 ********************************************************************/
837 BOOL prs_uint16s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
840 char *q = prs_mem_get(ps, len * sizeof(uint16));
844 if (UNMARSHALLING(ps)) {
845 if (ps->bigendian_data) {
846 for (i = 0; i < len; i++)
847 data16s[i] = RSVAL(q, 2*i);
849 for (i = 0; i < len; i++)
850 data16s[i] = SVAL(q, 2*i);
853 if (ps->bigendian_data) {
854 for (i = 0; i < len; i++)
855 RSSVAL(q, 2*i, data16s[i]);
857 for (i = 0; i < len; i++)
858 SSVAL(q, 2*i, data16s[i]);
862 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
864 print_asc(5, (unsigned char*)data16s, 2*len);
866 for (i = 0; i < len; i++)
867 DEBUG(5,("%04x ", data16s[i]));
871 ps->data_offset += (len * sizeof(uint16));
876 /******************************************************************
877 Start using a function for streaming unicode chars. If unmarshalling,
878 output must be little-endian, if marshalling, input must be little-endian.
879 ********************************************************************/
881 static void dbg_rw_punival(BOOL charmode, const char *name, int depth, prs_struct *ps,
882 char *in_buf, char *out_buf, int len)
886 if (UNMARSHALLING(ps)) {
887 if (ps->bigendian_data) {
888 for (i = 0; i < len; i++)
889 SSVAL(out_buf,2*i,RSVAL(in_buf, 2*i));
891 for (i = 0; i < len; i++)
892 SSVAL(out_buf, 2*i, SVAL(in_buf, 2*i));
895 if (ps->bigendian_data) {
896 for (i = 0; i < len; i++)
897 RSSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
899 for (i = 0; i < len; i++)
900 SSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
904 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
906 print_asc(5, (unsigned char*)out_buf, 2*len);
908 for (i = 0; i < len; i++)
909 DEBUG(5,("%04x ", out_buf[i]));
914 /******************************************************************
915 Stream a unistr. Always little endian.
916 ********************************************************************/
918 BOOL prs_uint16uni(BOOL charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
920 char *q = prs_mem_get(ps, len * sizeof(uint16));
924 dbg_rw_punival(charmode, name, depth, ps, q, (char *)data16s, len);
925 ps->data_offset += (len * sizeof(uint16));
930 /******************************************************************
931 Stream an array of uint32s. Length is number of uint32s.
932 ********************************************************************/
934 BOOL prs_uint32s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
937 char *q = prs_mem_get(ps, len * sizeof(uint32));
941 if (UNMARSHALLING(ps)) {
942 if (ps->bigendian_data) {
943 for (i = 0; i < len; i++)
944 data32s[i] = RIVAL(q, 4*i);
946 for (i = 0; i < len; i++)
947 data32s[i] = IVAL(q, 4*i);
950 if (ps->bigendian_data) {
951 for (i = 0; i < len; i++)
952 RSIVAL(q, 4*i, data32s[i]);
954 for (i = 0; i < len; i++)
955 SIVAL(q, 4*i, data32s[i]);
959 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
961 print_asc(5, (unsigned char*)data32s, 4*len);
963 for (i = 0; i < len; i++)
964 DEBUG(5,("%08x ", data32s[i]));
968 ps->data_offset += (len * sizeof(uint32));
973 /******************************************************************
974 Stream an array of unicode string, length/buffer specified separately,
975 in uint16 chars. The unicode string is already in little-endian format.
976 ********************************************************************/
978 BOOL prs_buffer5(BOOL charmode, const char *name, prs_struct *ps, int depth, BUFFER5 *str)
981 char *q = prs_mem_get(ps, str->buf_len * sizeof(uint16));
985 if (UNMARSHALLING(ps)) {
986 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->buf_len);
987 if (str->buffer == NULL)
991 /* If the string is empty, we don't have anything to stream */
995 p = (char *)str->buffer;
997 dbg_rw_punival(charmode, name, depth, ps, q, p, str->buf_len);
999 ps->data_offset += (str->buf_len * sizeof(uint16));
1004 /******************************************************************
1005 Stream a "not" unicode string, length/buffer specified separately,
1006 in byte chars. String is in little-endian format.
1007 ********************************************************************/
1009 BOOL prs_regval_buffer(BOOL charmode, const char *name, prs_struct *ps, int depth, REGVAL_BUFFER *buf)
1012 char *q = prs_mem_get(ps, buf->buf_len);
1016 if (UNMARSHALLING(ps)) {
1017 if (buf->buf_len > buf->buf_max_len) {
1020 if ( buf->buf_max_len ) {
1021 buf->buffer = PRS_ALLOC_MEM(ps, uint16, buf->buf_max_len);
1022 if ( buf->buffer == NULL )
1027 p = (char *)buf->buffer;
1029 dbg_rw_punival(charmode, name, depth, ps, q, p, buf->buf_len/2);
1030 ps->data_offset += buf->buf_len;
1035 /******************************************************************
1036 Stream a string, length/buffer specified separately,
1038 ********************************************************************/
1040 BOOL prs_string2(BOOL charmode, const char *name, prs_struct *ps, int depth, STRING2 *str)
1043 char *q = prs_mem_get(ps, str->str_str_len);
1047 if (UNMARSHALLING(ps)) {
1048 if (str->str_str_len > str->str_max_len) {
1051 str->buffer = PRS_ALLOC_MEM(ps,unsigned char, str->str_max_len);
1052 if (str->buffer == NULL)
1056 if (UNMARSHALLING(ps)) {
1057 for (i = 0; i < str->str_str_len; i++)
1058 str->buffer[i] = CVAL(q,i);
1060 for (i = 0; i < str->str_str_len; i++)
1061 SCVAL(q, i, str->buffer[i]);
1064 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1066 print_asc(5, (unsigned char*)str->buffer, str->str_str_len);
1068 for (i = 0; i < str->str_str_len; i++)
1069 DEBUG(5,("%02x ", str->buffer[i]));
1073 ps->data_offset += str->str_str_len;
1078 /******************************************************************
1079 Stream a unicode string, length/buffer specified separately,
1080 in uint16 chars. The unicode string is already in little-endian format.
1081 ********************************************************************/
1083 BOOL prs_unistr2(BOOL charmode, const char *name, prs_struct *ps, int depth, UNISTR2 *str)
1086 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1090 /* If the string is empty, we don't have anything to stream */
1091 if (str->uni_str_len==0)
1094 if (UNMARSHALLING(ps)) {
1095 if (str->uni_str_len > str->uni_max_len) {
1098 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_max_len);
1099 if (str->buffer == NULL)
1103 p = (char *)str->buffer;
1105 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1107 ps->data_offset += (str->uni_str_len * sizeof(uint16));
1112 /******************************************************************
1113 Stream a unicode string, length/buffer specified separately,
1114 in uint16 chars. The unicode string is already in little-endian format.
1115 ********************************************************************/
1117 BOOL prs_unistr3(BOOL charmode, const char *name, UNISTR3 *str, prs_struct *ps, int depth)
1120 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1124 if (UNMARSHALLING(ps)) {
1125 str->str.buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_str_len);
1126 if (str->str.buffer == NULL)
1130 p = (char *)str->str.buffer;
1132 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1133 ps->data_offset += (str->uni_str_len * sizeof(uint16));
1138 /*******************************************************************
1139 Stream a unicode null-terminated string. As the string is already
1140 in little-endian format then do it as a stream of bytes.
1141 ********************************************************************/
1143 BOOL prs_unistr(const char *name, prs_struct *ps, int depth, UNISTR *str)
1145 unsigned int len = 0;
1146 unsigned char *p = (unsigned char *)str->buffer;
1152 if (MARSHALLING(ps)) {
1154 for(len = 0; str->buffer[len] != 0; len++)
1157 q = prs_mem_get(ps, (len+1)*2);
1163 for(len = 0; str->buffer[len] != 0; len++) {
1164 if(ps->bigendian_data) {
1165 /* swap bytes - p is little endian, q is big endian. */
1181 * even if the string is 'empty' (only an \0 char)
1182 * at this point the leading \0 hasn't been parsed.
1192 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1193 print_asc(5, (unsigned char*)start, 2*len);
1196 else { /* unmarshalling */
1198 uint32 alloc_len = 0;
1199 q = ps->data_p + prs_offset(ps);
1202 * Work out how much space we need and talloc it.
1204 max_len = (ps->buffer_size - ps->data_offset)/sizeof(uint16);
1206 /* the test of the value of *ptr helps to catch the circumstance
1207 where we have an emtpty (non-existent) string in the buffer */
1208 for ( ptr = (uint16 *)q; *ptr++ && (alloc_len <= max_len); alloc_len++)
1212 if (alloc_len < max_len)
1215 /* should we allocate anything at all? */
1216 str->buffer = PRS_ALLOC_MEM(ps,uint16,alloc_len);
1217 if ((str->buffer == NULL) && (alloc_len > 0))
1220 p = (unsigned char *)str->buffer;
1223 /* the (len < alloc_len) test is to prevent us from overwriting
1224 memory that is not ours...if we get that far, we have a non-null
1225 terminated string in the buffer and have messed up somewhere */
1226 while ((len < alloc_len) && (*(uint16 *)q != 0)) {
1227 if(ps->bigendian_data)
1229 /* swap bytes - q is big endian, p is little endian. */
1230 p[0] = (unsigned char)q[1];
1231 p[1] = (unsigned char)q[0];
1236 p[0] = (unsigned char)q[0];
1237 p[1] = (unsigned char)q[1];
1244 if (len < alloc_len) {
1245 /* NULL terminate the UNISTR */
1246 str->buffer[len++] = '\0';
1249 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1250 print_asc(5, (unsigned char*)str->buffer, 2*len);
1254 /* set the offset in the prs_struct; 'len' points to the
1255 terminiating NULL in the UNISTR so we need to go one more
1257 ps->data_offset += (len)*2;
1263 /*******************************************************************
1264 Stream a null-terminated string. len is strlen, and therefore does
1265 not include the null-termination character.
1266 ********************************************************************/
1268 BOOL prs_string(const char *name, prs_struct *ps, int depth, char *str, int max_buf_size)
1274 if (UNMARSHALLING(ps))
1275 len = strlen(&ps->data_p[ps->data_offset]);
1279 len = MIN(len, (max_buf_size-1));
1281 q = prs_mem_get(ps, len+1);
1285 for(i = 0; i < len; i++) {
1286 if (UNMARSHALLING(ps))
1292 /* The terminating null. */
1295 if (MARSHALLING(ps)) {
1299 ps->data_offset += len+1;
1301 dump_data(5+depth, q, len);
1306 BOOL prs_string_alloc(const char *name, prs_struct *ps, int depth, const char **str)
1311 if (UNMARSHALLING(ps)) {
1312 len = strlen(&ps->data_p[ps->data_offset]);
1317 tmp_str = PRS_ALLOC_MEM(ps, char, len+1);
1319 if (tmp_str == NULL) {
1323 if (MARSHALLING(ps)) {
1324 strncpy(tmp_str, *str, len);
1327 if (!prs_string(name, ps, depth, tmp_str, len+1)) {
1335 /*******************************************************************
1336 Stream a null-terminated string of fixed len.
1337 ********************************************************************/
1339 BOOL prs_string_len(const char *name, prs_struct *ps, int depth, char *str, int len)
1343 BOOL charmode = True;
1345 q = prs_mem_get(ps, len+1);
1349 for(i = 0; i < len; i++) {
1350 if (UNMARSHALLING(ps))
1356 /* The terminating null. */
1359 if (MARSHALLING(ps)) {
1363 ps->data_offset += len+1;
1365 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1367 print_asc(5, (unsigned char*)str, len);
1369 for (i = 0; i < len; i++)
1370 DEBUG(5,("%04x ", str[i]));
1378 /*******************************************************************
1379 prs_uint16 wrapper. Call this and it sets up a pointer to where the
1380 uint16 should be stored, or gets the size if reading.
1381 ********************************************************************/
1383 BOOL prs_uint16_pre(const char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
1385 *offset = ps->data_offset;
1386 if (UNMARSHALLING(ps)) {
1388 return prs_uint16(name, ps, depth, data16);
1390 char *q = prs_mem_get(ps, sizeof(uint16));
1393 ps->data_offset += sizeof(uint16);
1398 /*******************************************************************
1399 prs_uint16 wrapper. call this and it retrospectively stores the size.
1400 does nothing on reading, as that is already handled by ...._pre()
1401 ********************************************************************/
1403 BOOL prs_uint16_post(const char *name, prs_struct *ps, int depth, uint16 *data16,
1404 uint32 ptr_uint16, uint32 start_offset)
1406 if (MARSHALLING(ps)) {
1408 * Writing - temporarily move the offset pointer.
1410 uint16 data_size = ps->data_offset - start_offset;
1411 uint32 old_offset = ps->data_offset;
1413 ps->data_offset = ptr_uint16;
1414 if(!prs_uint16(name, ps, depth, &data_size)) {
1415 ps->data_offset = old_offset;
1418 ps->data_offset = old_offset;
1420 ps->data_offset = start_offset + (uint32)(*data16);
1425 /*******************************************************************
1426 prs_uint32 wrapper. Call this and it sets up a pointer to where the
1427 uint32 should be stored, or gets the size if reading.
1428 ********************************************************************/
1430 BOOL prs_uint32_pre(const char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
1432 *offset = ps->data_offset;
1433 if (UNMARSHALLING(ps) && (data32 != NULL)) {
1435 return prs_uint32(name, ps, depth, data32);
1437 ps->data_offset += sizeof(uint32);
1442 /*******************************************************************
1443 prs_uint32 wrapper. call this and it retrospectively stores the size.
1444 does nothing on reading, as that is already handled by ...._pre()
1445 ********************************************************************/
1447 BOOL prs_uint32_post(const char *name, prs_struct *ps, int depth, uint32 *data32,
1448 uint32 ptr_uint32, uint32 data_size)
1450 if (MARSHALLING(ps)) {
1452 * Writing - temporarily move the offset pointer.
1454 uint32 old_offset = ps->data_offset;
1455 ps->data_offset = ptr_uint32;
1456 if(!prs_uint32(name, ps, depth, &data_size)) {
1457 ps->data_offset = old_offset;
1460 ps->data_offset = old_offset;
1465 /* useful function to store a structure in rpc wire format */
1466 int tdb_prs_store(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
1468 TDB_DATA kbuf, dbuf;
1470 kbuf.dsize = strlen(keystr)+1;
1471 dbuf.dptr = ps->data_p;
1472 dbuf.dsize = prs_offset(ps);
1473 return tdb_store(tdb, kbuf, dbuf, TDB_REPLACE);
1476 /* useful function to fetch a structure into rpc wire format */
1477 int tdb_prs_fetch(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps, TALLOC_CTX *mem_ctx)
1479 TDB_DATA kbuf, dbuf;
1481 kbuf.dsize = strlen(keystr)+1;
1483 dbuf = tdb_fetch(tdb, kbuf);
1487 prs_init(ps, 0, mem_ctx, UNMARSHALL);
1488 prs_give_memory(ps, dbuf.dptr, dbuf.dsize, True);
1493 /*******************************************************************
1495 ********************************************************************/
1497 BOOL prs_hash1(prs_struct *ps, uint32 offset, int len)
1504 #ifdef DEBUG_PASSWORD
1505 DEBUG(100, ("prs_hash1\n"));
1506 dump_data(100, ps->sess_key, 16);
1507 dump_data(100, q, len);
1509 SamOEMhash((uchar *) q, (const unsigned char *)ps->sess_key, len);
1511 #ifdef DEBUG_PASSWORD
1512 dump_data(100, q, len);
1518 /*******************************************************************
1519 Create a digest over the entire packet (including the data), and
1520 MD5 it with the session key.
1521 ********************************************************************/
1523 static void schannel_digest(struct schannel_auth_struct *a,
1524 enum pipe_auth_level auth_level,
1525 RPC_AUTH_SCHANNEL_CHK * verf,
1526 char *data, size_t data_len,
1527 uchar digest_final[16])
1529 uchar whole_packet_digest[16];
1530 static uchar zeros[4];
1531 struct MD5Context ctx3;
1533 /* verfiy the signature on the packet by MD5 over various bits */
1535 /* use our sequence number, which ensures the packet is not
1537 MD5Update(&ctx3, zeros, sizeof(zeros));
1538 MD5Update(&ctx3, verf->sig, sizeof(verf->sig));
1539 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1540 MD5Update(&ctx3, verf->confounder, sizeof(verf->confounder));
1542 MD5Update(&ctx3, (const unsigned char *)data, data_len);
1543 MD5Final(whole_packet_digest, &ctx3);
1544 dump_data_pw("whole_packet_digest:\n", whole_packet_digest, sizeof(whole_packet_digest));
1546 /* MD5 this result and the session key, to prove that
1547 only a valid client could had produced this */
1548 hmac_md5(a->sess_key, whole_packet_digest, sizeof(whole_packet_digest), digest_final);
1551 /*******************************************************************
1552 Calculate the key with which to encode the data payload
1553 ********************************************************************/
1555 static void schannel_get_sealing_key(struct schannel_auth_struct *a,
1556 RPC_AUTH_SCHANNEL_CHK *verf,
1557 uchar sealing_key[16])
1559 static uchar zeros[4];
1564 for (i = 0; i < sizeof(sess_kf0); i++) {
1565 sess_kf0[i] = a->sess_key[i] ^ 0xf0;
1568 dump_data_pw("sess_kf0:\n", sess_kf0, sizeof(sess_kf0));
1570 /* MD5 of sess_kf0 and 4 zero bytes */
1571 hmac_md5(sess_kf0, zeros, 0x4, digest2);
1572 dump_data_pw("digest2:\n", digest2, sizeof(digest2));
1574 /* MD5 of the above result, plus 8 bytes of sequence number */
1575 hmac_md5(digest2, verf->seq_num, sizeof(verf->seq_num), sealing_key);
1576 dump_data_pw("sealing_key:\n", sealing_key, 16);
1579 /*******************************************************************
1580 Encode or Decode the sequence number (which is symmetric)
1581 ********************************************************************/
1583 static void schannel_deal_with_seq_num(struct schannel_auth_struct *a,
1584 RPC_AUTH_SCHANNEL_CHK *verf)
1586 static uchar zeros[4];
1587 uchar sequence_key[16];
1590 hmac_md5(a->sess_key, zeros, sizeof(zeros), digest1);
1591 dump_data_pw("(sequence key) digest1:\n", digest1, sizeof(digest1));
1593 hmac_md5(digest1, verf->packet_digest, 8, sequence_key);
1595 dump_data_pw("sequence_key:\n", sequence_key, sizeof(sequence_key));
1597 dump_data_pw("seq_num (before):\n", verf->seq_num, sizeof(verf->seq_num));
1598 SamOEMhash(verf->seq_num, sequence_key, 8);
1599 dump_data_pw("seq_num (after):\n", verf->seq_num, sizeof(verf->seq_num));
1602 /*******************************************************************
1603 creates an RPC_AUTH_SCHANNEL_CHK structure.
1604 ********************************************************************/
1606 static BOOL init_rpc_auth_schannel_chk(RPC_AUTH_SCHANNEL_CHK * chk,
1608 const uchar packet_digest[8],
1609 const uchar seq_num[8], const uchar confounder[8])
1614 memcpy(chk->sig, sig, sizeof(chk->sig));
1615 memcpy(chk->packet_digest, packet_digest, sizeof(chk->packet_digest));
1616 memcpy(chk->seq_num, seq_num, sizeof(chk->seq_num));
1617 memcpy(chk->confounder, confounder, sizeof(chk->confounder));
1622 /*******************************************************************
1623 Encode a blob of data using the schannel alogrithm, also produceing
1624 a checksum over the original data. We currently only support
1625 signing and sealing togeather - the signing-only code is close, but not
1626 quite compatible with what MS does.
1627 ********************************************************************/
1629 void schannel_encode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1630 enum schannel_direction direction,
1631 RPC_AUTH_SCHANNEL_CHK * verf,
1632 char *data, size_t data_len)
1634 uchar digest_final[16];
1635 uchar confounder[8];
1637 static const uchar nullbytes[8];
1639 static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1640 static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1641 const uchar *schannel_sig = NULL;
1643 DEBUG(10,("SCHANNEL: schannel_encode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1645 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1646 schannel_sig = schannel_seal_sig;
1648 schannel_sig = schannel_sign_sig;
1651 /* fill the 'confounder' with random data */
1652 generate_random_buffer(confounder, sizeof(confounder));
1654 dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1656 RSIVAL(seq_num, 0, a->seq_num);
1658 switch (direction) {
1659 case SENDER_IS_INITIATOR:
1660 SIVAL(seq_num, 4, 0x80);
1662 case SENDER_IS_ACCEPTOR:
1663 SIVAL(seq_num, 4, 0x0);
1667 dump_data_pw("verf->seq_num:\n", seq_num, sizeof(verf->seq_num));
1669 init_rpc_auth_schannel_chk(verf, schannel_sig, nullbytes,
1670 seq_num, confounder);
1672 /* produce a digest of the packet to prove it's legit (before we seal it) */
1673 schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1674 memcpy(verf->packet_digest, digest_final, sizeof(verf->packet_digest));
1676 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1677 uchar sealing_key[16];
1679 /* get the key to encode the data with */
1680 schannel_get_sealing_key(a, verf, sealing_key);
1682 /* encode the verification data */
1683 dump_data_pw("verf->confounder:\n", verf->confounder, sizeof(verf->confounder));
1684 SamOEMhash(verf->confounder, sealing_key, 8);
1686 dump_data_pw("verf->confounder_enc:\n", verf->confounder, sizeof(verf->confounder));
1688 /* encode the packet payload */
1689 dump_data_pw("data:\n", (const unsigned char *)data, data_len);
1690 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1691 dump_data_pw("data_enc:\n", (const unsigned char *)data, data_len);
1694 /* encode the sequence number (key based on packet digest) */
1695 /* needs to be done after the sealing, as the original version
1696 is used in the sealing stuff... */
1697 schannel_deal_with_seq_num(a, verf);
1702 /*******************************************************************
1703 Decode a blob of data using the schannel alogrithm, also verifiying
1704 a checksum over the original data. We currently can verify signed messages,
1705 as well as decode sealed messages
1706 ********************************************************************/
1708 BOOL schannel_decode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1709 enum schannel_direction direction,
1710 RPC_AUTH_SCHANNEL_CHK * verf, char *data, size_t data_len)
1712 uchar digest_final[16];
1714 static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1715 static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1716 const uchar *schannel_sig = NULL;
1720 DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1722 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1723 schannel_sig = schannel_seal_sig;
1725 schannel_sig = schannel_sign_sig;
1728 /* Create the expected sequence number for comparison */
1729 RSIVAL(seq_num, 0, a->seq_num);
1731 switch (direction) {
1732 case SENDER_IS_INITIATOR:
1733 SIVAL(seq_num, 4, 0x80);
1735 case SENDER_IS_ACCEPTOR:
1736 SIVAL(seq_num, 4, 0x0);
1740 DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1741 dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1743 dump_data_pw("seq_num:\n", seq_num, sizeof(seq_num));
1745 /* extract the sequence number (key based on supplied packet digest) */
1746 /* needs to be done before the sealing, as the original version
1747 is used in the sealing stuff... */
1748 schannel_deal_with_seq_num(a, verf);
1750 if (memcmp(verf->seq_num, seq_num, sizeof(seq_num))) {
1751 /* don't even bother with the below if the sequence number is out */
1752 /* The sequence number is MD5'ed with a key based on the whole-packet
1753 digest, as supplied by the client. We check that it's a valid
1754 checksum after the decode, below
1756 DEBUG(2, ("schannel_decode: FAILED: packet sequence number:\n"));
1757 dump_data(2, (const char*)verf->seq_num, sizeof(verf->seq_num));
1758 DEBUG(2, ("should be:\n"));
1759 dump_data(2, (const char*)seq_num, sizeof(seq_num));
1764 if (memcmp(verf->sig, schannel_sig, sizeof(verf->sig))) {
1765 /* Validate that the other end sent the expected header */
1766 DEBUG(2, ("schannel_decode: FAILED: packet header:\n"));
1767 dump_data(2, (const char*)verf->sig, sizeof(verf->sig));
1768 DEBUG(2, ("should be:\n"));
1769 dump_data(2, (const char*)schannel_sig, sizeof(schannel_sig));
1773 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1774 uchar sealing_key[16];
1776 /* get the key to extract the data with */
1777 schannel_get_sealing_key(a, verf, sealing_key);
1779 /* extract the verification data */
1780 dump_data_pw("verf->confounder:\n", verf->confounder,
1781 sizeof(verf->confounder));
1782 SamOEMhash(verf->confounder, sealing_key, 8);
1784 dump_data_pw("verf->confounder_dec:\n", verf->confounder,
1785 sizeof(verf->confounder));
1787 /* extract the packet payload */
1788 dump_data_pw("data :\n", (const unsigned char *)data, data_len);
1789 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1790 dump_data_pw("datadec:\n", (const unsigned char *)data, data_len);
1793 /* digest includes 'data' after unsealing */
1794 schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1796 dump_data_pw("Calculated digest:\n", digest_final,
1797 sizeof(digest_final));
1798 dump_data_pw("verf->packet_digest:\n", verf->packet_digest,
1799 sizeof(verf->packet_digest));
1801 /* compare - if the client got the same result as us, then
1802 it must know the session key */
1803 return (memcmp(digest_final, verf->packet_digest,
1804 sizeof(verf->packet_digest)) == 0);