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 3 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, see <http://www.gnu.org/licenses/>.
26 #define DBGC_CLASS DBGC_RPC_PARSE
29 * Dump a prs to a file: from the current location through to the end.
31 void prs_dump(const char *name, int v, prs_struct *ps)
33 prs_dump_region(name, v, ps, ps->data_offset, ps->buffer_size);
37 * Dump from the start of the prs to the current location.
39 void prs_dump_before(const char *name, int v, prs_struct *ps)
41 prs_dump_region(name, v, ps, 0, ps->data_offset);
45 * Dump everything from the start of the prs up to the current location.
47 void prs_dump_region(const char *name, int v, prs_struct *ps,
48 int from_off, int to_off)
53 if (DEBUGLEVEL < 50) return;
56 if (asprintf(&fname,"/tmp/%s_%d.%d.prs", name, v, i) < 0) {
60 if (asprintf(&fname,"/tmp/%s.%d.prs", name, i) < 0) {
64 fd = open(fname, O_WRONLY|O_CREAT|O_EXCL, 0644);
65 if (fd != -1 || errno != EEXIST) break;
68 sz = write(fd, ps->data_p + from_off, to_off - from_off);
70 if ( (sz != to_off-from_off) || (i != 0) ) {
71 DEBUG(0,("Error writing/closing %s: %ld!=%ld %d\n", fname, (unsigned long)sz, (unsigned long)to_off-from_off, i ));
73 DEBUG(0,("created %s\n", fname));
79 /*******************************************************************
80 Debug output for parsing info
82 XXXX side-effect of this function is to increase the debug depth XXXX.
84 ********************************************************************/
86 void prs_debug(prs_struct *ps, int depth, const char *desc, const char *fn_name)
88 DEBUG(5+depth, ("%s%06x %s %s\n", tab_depth(5+depth,depth), ps->data_offset, fn_name, desc));
92 * Initialise an expandable parse structure.
94 * @param size Initial buffer size. If >0, a new buffer will be
95 * created with malloc().
97 * @return False if allocation fails, otherwise True.
100 bool prs_init(prs_struct *ps, uint32 size, TALLOC_CTX *ctx, bool io)
104 ps->bigendian_data = RPC_LITTLE_ENDIAN;
105 ps->align = RPC_PARSE_ALIGN;
106 ps->is_dynamic = False;
113 ps->buffer_size = size;
114 if((ps->data_p = (char *)SMB_MALLOC((size_t)size)) == NULL) {
115 DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size));
118 memset(ps->data_p, '\0', (size_t)size);
119 ps->is_dynamic = True; /* We own this memory. */
120 } else if (MARSHALLING(ps)) {
121 /* If size is zero and we're marshalling we should allocate memory on demand. */
122 ps->is_dynamic = True;
128 /*******************************************************************
129 Delete the memory in a parse structure - if we own it.
131 NOTE: Contrary to the somewhat confusing naming, this function is not
132 intended for freeing memory allocated by prs_alloc_mem(). That memory
133 is attached to the talloc context given by ps->mem_ctx.
134 ********************************************************************/
136 void prs_mem_free(prs_struct *ps)
139 SAFE_FREE(ps->data_p);
140 ps->is_dynamic = False;
145 /*******************************************************************
146 Clear the memory in a parse structure.
147 ********************************************************************/
149 void prs_mem_clear(prs_struct *ps)
152 memset(ps->data_p, '\0', (size_t)ps->buffer_size);
155 /*******************************************************************
156 Allocate memory when unmarshalling... Always zero clears.
157 ********************************************************************/
159 #if defined(PARANOID_MALLOC_CHECKER)
160 char *prs_alloc_mem_(prs_struct *ps, size_t size, unsigned int count)
162 char *prs_alloc_mem(prs_struct *ps, size_t size, unsigned int count)
168 /* We can't call the type-safe version here. */
169 ret = (char *)_talloc_zero_array(ps->mem_ctx, size, count,
175 /*******************************************************************
176 Return the current talloc context we're using.
177 ********************************************************************/
179 TALLOC_CTX *prs_get_mem_context(prs_struct *ps)
184 /*******************************************************************
185 Hand some already allocated memory to a prs_struct.
186 ********************************************************************/
188 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, bool is_dynamic)
190 ps->is_dynamic = is_dynamic;
192 ps->buffer_size = size;
195 /*******************************************************************
196 Take some memory back from a prs_struct.
197 ********************************************************************/
199 char *prs_take_memory(prs_struct *ps, uint32 *psize)
201 char *ret = ps->data_p;
203 *psize = ps->buffer_size;
204 ps->is_dynamic = False;
209 /*******************************************************************
210 Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
211 ********************************************************************/
213 bool prs_set_buffer_size(prs_struct *ps, uint32 newsize)
215 if (newsize > ps->buffer_size)
216 return prs_force_grow(ps, newsize - ps->buffer_size);
218 if (newsize < ps->buffer_size) {
219 ps->buffer_size = newsize;
221 /* newsize == 0 acts as a free and set pointer to NULL */
223 SAFE_FREE(ps->data_p);
225 ps->data_p = (char *)SMB_REALLOC(ps->data_p, newsize);
227 if (ps->data_p == NULL) {
228 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
229 (unsigned int)newsize));
230 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno)));
239 /*******************************************************************
240 Attempt, if needed, to grow a data buffer.
241 Also depends on the data stream mode (io).
242 ********************************************************************/
244 bool prs_grow(prs_struct *ps, uint32 extra_space)
248 ps->grow_size = MAX(ps->grow_size, ps->data_offset + extra_space);
250 if(ps->data_offset + extra_space <= ps->buffer_size)
254 * We cannot grow the buffer if we're not reading
255 * into the prs_struct, or if we don't own the memory.
258 if(UNMARSHALLING(ps) || !ps->is_dynamic) {
259 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
260 (unsigned int)extra_space));
265 * Decide how much extra space we really need.
268 extra_space -= (ps->buffer_size - ps->data_offset);
269 if(ps->buffer_size == 0) {
272 * Start with 128 bytes (arbitrary value), enough for small rpc
275 new_size = MAX(128, extra_space);
277 if((ps->data_p = (char *)SMB_MALLOC(new_size)) == NULL) {
278 DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size));
281 memset(ps->data_p, '\0', (size_t)new_size );
284 * If the current buffer size is bigger than the space needed,
285 * just double it, else add extra_space. Always keep 64 bytes
286 * more, so that after we added a large blob we don't have to
287 * realloc immediately again.
289 new_size = MAX(ps->buffer_size*2,
290 ps->buffer_size + extra_space + 64);
292 if ((ps->data_p = (char *)SMB_REALLOC(ps->data_p, new_size)) == NULL) {
293 DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
294 (unsigned int)new_size));
298 memset(&ps->data_p[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
300 ps->buffer_size = new_size;
305 /*******************************************************************
306 Attempt to force a data buffer to grow by len bytes.
307 This is only used when appending more data onto a prs_struct
308 when reading an rpc reply, before unmarshalling it.
309 ********************************************************************/
311 bool prs_force_grow(prs_struct *ps, uint32 extra_space)
313 uint32 new_size = ps->buffer_size + extra_space;
315 if(!UNMARSHALLING(ps) || !ps->is_dynamic) {
316 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
317 (unsigned int)extra_space));
321 if((ps->data_p = (char *)SMB_REALLOC(ps->data_p, new_size)) == NULL) {
322 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
323 (unsigned int)new_size));
327 memset(&ps->data_p[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
329 ps->buffer_size = new_size;
334 /*******************************************************************
335 Get the data pointer (external interface).
336 ********************************************************************/
338 char *prs_data_p(prs_struct *ps)
343 /*******************************************************************
344 Get the current data size (external interface).
345 ********************************************************************/
347 uint32 prs_data_size(prs_struct *ps)
349 return ps->buffer_size;
352 /*******************************************************************
353 Fetch the current offset (external interface).
354 ********************************************************************/
356 uint32 prs_offset(prs_struct *ps)
358 return ps->data_offset;
361 /*******************************************************************
362 Set the current offset (external interface).
363 ********************************************************************/
365 bool prs_set_offset(prs_struct *ps, uint32 offset)
367 if ((offset > ps->data_offset)
368 && !prs_grow(ps, offset - ps->data_offset)) {
372 ps->data_offset = offset;
376 /*******************************************************************
377 Append the data from one parse_struct into another.
378 ********************************************************************/
380 bool prs_append_prs_data(prs_struct *dst, prs_struct *src)
382 if (prs_offset(src) == 0)
385 if(!prs_grow(dst, prs_offset(src)))
388 memcpy(&dst->data_p[dst->data_offset], src->data_p, (size_t)prs_offset(src));
389 dst->data_offset += prs_offset(src);
394 /*******************************************************************
395 Append some data from one parse_struct into another.
396 ********************************************************************/
398 bool prs_append_some_data(prs_struct *dst, void *src_base, uint32_t start,
405 if(!prs_grow(dst, len)) {
409 memcpy(&dst->data_p[dst->data_offset], ((char *)src_base) + start, (size_t)len);
410 dst->data_offset += len;
414 bool prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start,
417 return prs_append_some_data(dst, src->data_p, start, len);
420 /*******************************************************************
421 Append the data from a buffer into a parse_struct.
422 ********************************************************************/
424 bool prs_copy_data_in(prs_struct *dst, const char *src, uint32 len)
429 if(!prs_grow(dst, len))
432 memcpy(&dst->data_p[dst->data_offset], src, (size_t)len);
433 dst->data_offset += len;
438 /*******************************************************************
439 Copy some data from a parse_struct into a buffer.
440 ********************************************************************/
442 bool prs_copy_data_out(char *dst, prs_struct *src, uint32 len)
447 if(!prs_mem_get(src, len))
450 memcpy(dst, &src->data_p[src->data_offset], (size_t)len);
451 src->data_offset += len;
456 /*******************************************************************
457 Copy all the data from a parse_struct into a buffer.
458 ********************************************************************/
460 bool prs_copy_all_data_out(char *dst, prs_struct *src)
462 uint32 len = prs_offset(src);
467 prs_set_offset(src, 0);
468 return prs_copy_data_out(dst, src, len);
471 /*******************************************************************
472 Set the data as X-endian (external interface).
473 ********************************************************************/
475 void prs_set_endian_data(prs_struct *ps, bool endian)
477 ps->bigendian_data = endian;
480 /*******************************************************************
481 Align a the data_len to a multiple of align bytes - filling with
483 ********************************************************************/
485 bool prs_align(prs_struct *ps)
487 uint32 mod = ps->data_offset & (ps->align-1);
489 if (ps->align != 0 && mod != 0) {
490 uint32 extra_space = (ps->align - mod);
491 if(!prs_grow(ps, extra_space))
493 memset(&ps->data_p[ps->data_offset], '\0', (size_t)extra_space);
494 ps->data_offset += extra_space;
500 /******************************************************************
501 Align on a 2 byte boundary
502 *****************************************************************/
504 bool prs_align_uint16(prs_struct *ps)
507 uint8 old_align = ps->align;
511 ps->align = old_align;
516 /******************************************************************
517 Align on a 8 byte boundary
518 *****************************************************************/
520 bool prs_align_uint64(prs_struct *ps)
523 uint8 old_align = ps->align;
527 ps->align = old_align;
532 /******************************************************************
533 Align on a specific byte boundary
534 *****************************************************************/
536 bool prs_align_custom(prs_struct *ps, uint8 boundary)
539 uint8 old_align = ps->align;
541 ps->align = boundary;
543 ps->align = old_align;
550 /*******************************************************************
551 Align only if required (for the unistr2 string mainly)
552 ********************************************************************/
554 bool prs_align_needed(prs_struct *ps, uint32 needed)
559 return prs_align(ps);
562 /*******************************************************************
563 Ensure we can read/write to a given offset.
564 ********************************************************************/
566 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
568 if(UNMARSHALLING(ps)) {
570 * If reading, ensure that we can read the requested size item.
572 if (ps->data_offset + extra_size > ps->buffer_size) {
573 DEBUG(0,("prs_mem_get: reading data of size %u would overrun "
574 "buffer by %u bytes.\n",
575 (unsigned int)extra_size,
576 (unsigned int)(ps->data_offset + extra_size - ps->buffer_size) ));
581 * Writing - grow the buffer if needed.
583 if(!prs_grow(ps, extra_size))
586 return &ps->data_p[ps->data_offset];
589 /*******************************************************************
590 Change the struct type.
591 ********************************************************************/
593 void prs_switch_type(prs_struct *ps, bool io)
595 if ((ps->io ^ io) == True)
599 /*******************************************************************
600 Force a prs_struct to be dynamic even when it's size is 0.
601 ********************************************************************/
603 void prs_force_dynamic(prs_struct *ps)
608 /*******************************************************************
609 Associate a session key with a parse struct.
610 ********************************************************************/
612 void prs_set_session_key(prs_struct *ps, const char sess_key[16])
614 ps->sess_key = sess_key;
617 /*******************************************************************
619 ********************************************************************/
621 bool prs_uint8(const char *name, prs_struct *ps, int depth, uint8 *data8)
623 char *q = prs_mem_get(ps, 1);
627 if (UNMARSHALLING(ps))
632 DEBUGADD(5,("%s%04x %s: %02x\n", tab_depth(5,depth), ps->data_offset, name, *data8));
634 ps->data_offset += 1;
639 /*******************************************************************
640 Stream a uint16* (allocate memory if unmarshalling)
641 ********************************************************************/
643 bool prs_pointer( const char *name, prs_struct *ps, int depth,
644 void *dta, size_t data_size,
645 bool (*prs_fn)(const char*, prs_struct*, int, void*) )
647 void ** data = (void **)dta;
650 /* output f000baaa to stream if the pointer is non-zero. */
652 data_p = *data ? 0xf000baaa : 0;
654 if ( !prs_uint32("ptr", ps, depth, &data_p ))
657 /* we're done if there is no data */
662 if (UNMARSHALLING(ps)) {
664 if ( !(*data = PRS_ALLOC_MEM(ps, char, data_size)) )
671 return prs_fn(name, ps, depth, *data);
675 /*******************************************************************
677 ********************************************************************/
679 bool prs_uint16(const char *name, prs_struct *ps, int depth, uint16 *data16)
681 char *q = prs_mem_get(ps, sizeof(uint16));
685 if (UNMARSHALLING(ps)) {
686 if (ps->bigendian_data)
687 *data16 = RSVAL(q,0);
691 if (ps->bigendian_data)
697 DEBUGADD(5,("%s%04x %s: %04x\n", tab_depth(5,depth), ps->data_offset, name, *data16));
699 ps->data_offset += sizeof(uint16);
704 /*******************************************************************
706 ********************************************************************/
708 bool prs_uint32(const char *name, prs_struct *ps, int depth, uint32 *data32)
710 char *q = prs_mem_get(ps, sizeof(uint32));
714 if (UNMARSHALLING(ps)) {
715 if (ps->bigendian_data)
716 *data32 = RIVAL(q,0);
720 if (ps->bigendian_data)
726 DEBUGADD(5,("%s%04x %s: %08x\n", tab_depth(5,depth), ps->data_offset, name, *data32));
728 ps->data_offset += sizeof(uint32);
733 /*******************************************************************
735 ********************************************************************/
737 bool prs_int32(const char *name, prs_struct *ps, int depth, int32 *data32)
739 char *q = prs_mem_get(ps, sizeof(int32));
743 if (UNMARSHALLING(ps)) {
744 if (ps->bigendian_data)
745 *data32 = RIVALS(q,0);
747 *data32 = IVALS(q,0);
749 if (ps->bigendian_data)
750 RSIVALS(q,0,*data32);
755 DEBUGADD(5,("%s%04x %s: %08x\n", tab_depth(5,depth), ps->data_offset, name, *data32));
757 ps->data_offset += sizeof(int32);
762 /*******************************************************************
764 ********************************************************************/
766 bool prs_ntstatus(const char *name, prs_struct *ps, int depth, NTSTATUS *status)
768 char *q = prs_mem_get(ps, sizeof(uint32));
772 if (UNMARSHALLING(ps)) {
773 if (ps->bigendian_data)
774 *status = NT_STATUS(RIVAL(q,0));
776 *status = NT_STATUS(IVAL(q,0));
778 if (ps->bigendian_data)
779 RSIVAL(q,0,NT_STATUS_V(*status));
781 SIVAL(q,0,NT_STATUS_V(*status));
784 DEBUGADD(5,("%s%04x %s: %s\n", tab_depth(5,depth), ps->data_offset, name,
785 nt_errstr(*status)));
787 ps->data_offset += sizeof(uint32);
792 /*******************************************************************
793 Stream a DCE error code
794 ********************************************************************/
796 bool prs_dcerpc_status(const char *name, prs_struct *ps, int depth, NTSTATUS *status)
798 char *q = prs_mem_get(ps, sizeof(uint32));
802 if (UNMARSHALLING(ps)) {
803 if (ps->bigendian_data)
804 *status = NT_STATUS(RIVAL(q,0));
806 *status = NT_STATUS(IVAL(q,0));
808 if (ps->bigendian_data)
809 RSIVAL(q,0,NT_STATUS_V(*status));
811 SIVAL(q,0,NT_STATUS_V(*status));
814 DEBUGADD(5,("%s%04x %s: %s\n", tab_depth(5,depth), ps->data_offset, name,
815 dcerpc_errstr(debug_ctx(), NT_STATUS_V(*status))));
817 ps->data_offset += sizeof(uint32);
823 /*******************************************************************
825 ********************************************************************/
827 bool prs_werror(const char *name, prs_struct *ps, int depth, WERROR *status)
829 char *q = prs_mem_get(ps, sizeof(uint32));
833 if (UNMARSHALLING(ps)) {
834 if (ps->bigendian_data)
835 *status = W_ERROR(RIVAL(q,0));
837 *status = W_ERROR(IVAL(q,0));
839 if (ps->bigendian_data)
840 RSIVAL(q,0,W_ERROR_V(*status));
842 SIVAL(q,0,W_ERROR_V(*status));
845 DEBUGADD(5,("%s%04x %s: %s\n", tab_depth(5,depth), ps->data_offset, name,
846 win_errstr(*status)));
848 ps->data_offset += sizeof(uint32);
854 /******************************************************************
855 Stream an array of uint8s. Length is number of uint8s.
856 ********************************************************************/
858 bool prs_uint8s(bool charmode, const char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
861 char *q = prs_mem_get(ps, len);
865 if (UNMARSHALLING(ps)) {
866 for (i = 0; i < len; i++)
867 data8s[i] = CVAL(q,i);
869 for (i = 0; i < len; i++)
870 SCVAL(q, i, data8s[i]);
873 DEBUGADD(5,("%s%04x %s: ", tab_depth(5,depth), ps->data_offset ,name));
875 print_asc(5, (unsigned char*)data8s, len);
877 for (i = 0; i < len; i++)
878 DEBUGADD(5,("%02x ", data8s[i]));
882 ps->data_offset += len;
887 /******************************************************************
888 Stream an array of uint16s. Length is number of uint16s.
889 ********************************************************************/
891 bool prs_uint16s(bool charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
894 char *q = prs_mem_get(ps, len * sizeof(uint16));
898 if (UNMARSHALLING(ps)) {
899 if (ps->bigendian_data) {
900 for (i = 0; i < len; i++)
901 data16s[i] = RSVAL(q, 2*i);
903 for (i = 0; i < len; i++)
904 data16s[i] = SVAL(q, 2*i);
907 if (ps->bigendian_data) {
908 for (i = 0; i < len; i++)
909 RSSVAL(q, 2*i, data16s[i]);
911 for (i = 0; i < len; i++)
912 SSVAL(q, 2*i, data16s[i]);
916 DEBUGADD(5,("%s%04x %s: ", tab_depth(5,depth), ps->data_offset, name));
918 print_asc(5, (unsigned char*)data16s, 2*len);
920 for (i = 0; i < len; i++)
921 DEBUGADD(5,("%04x ", data16s[i]));
925 ps->data_offset += (len * sizeof(uint16));
930 /******************************************************************
931 Start using a function for streaming unicode chars. If unmarshalling,
932 output must be little-endian, if marshalling, input must be little-endian.
933 ********************************************************************/
935 static void dbg_rw_punival(bool charmode, const char *name, int depth, prs_struct *ps,
936 char *in_buf, char *out_buf, int len)
940 if (UNMARSHALLING(ps)) {
941 if (ps->bigendian_data) {
942 for (i = 0; i < len; i++)
943 SSVAL(out_buf,2*i,RSVAL(in_buf, 2*i));
945 for (i = 0; i < len; i++)
946 SSVAL(out_buf, 2*i, SVAL(in_buf, 2*i));
949 if (ps->bigendian_data) {
950 for (i = 0; i < len; i++)
951 RSSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
953 for (i = 0; i < len; i++)
954 SSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
958 DEBUGADD(5,("%s%04x %s: ", tab_depth(5,depth), ps->data_offset, name));
960 print_asc(5, (unsigned char*)out_buf, 2*len);
962 for (i = 0; i < len; i++)
963 DEBUGADD(5,("%04x ", out_buf[i]));
968 /******************************************************************
969 Stream a unistr. Always little endian.
970 ********************************************************************/
972 bool prs_uint16uni(bool charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
974 char *q = prs_mem_get(ps, len * sizeof(uint16));
978 dbg_rw_punival(charmode, name, depth, ps, q, (char *)data16s, len);
979 ps->data_offset += (len * sizeof(uint16));
984 /******************************************************************
985 Stream an array of uint32s. Length is number of uint32s.
986 ********************************************************************/
988 bool prs_uint32s(bool charmode, const char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
991 char *q = prs_mem_get(ps, len * sizeof(uint32));
995 if (UNMARSHALLING(ps)) {
996 if (ps->bigendian_data) {
997 for (i = 0; i < len; i++)
998 data32s[i] = RIVAL(q, 4*i);
1000 for (i = 0; i < len; i++)
1001 data32s[i] = IVAL(q, 4*i);
1004 if (ps->bigendian_data) {
1005 for (i = 0; i < len; i++)
1006 RSIVAL(q, 4*i, data32s[i]);
1008 for (i = 0; i < len; i++)
1009 SIVAL(q, 4*i, data32s[i]);
1013 DEBUGADD(5,("%s%04x %s: ", tab_depth(5,depth), ps->data_offset, name));
1015 print_asc(5, (unsigned char*)data32s, 4*len);
1017 for (i = 0; i < len; i++)
1018 DEBUGADD(5,("%08x ", data32s[i]));
1022 ps->data_offset += (len * sizeof(uint32));
1027 /******************************************************************
1028 Stream an array of unicode string, length/buffer specified separately,
1029 in uint16 chars. The unicode string is already in little-endian format.
1030 ********************************************************************/
1032 bool prs_buffer5(bool charmode, const char *name, prs_struct *ps, int depth, BUFFER5 *str)
1035 char *q = prs_mem_get(ps, str->buf_len * sizeof(uint16));
1039 /* If the string is empty, we don't have anything to stream */
1040 if (str->buf_len==0)
1043 if (UNMARSHALLING(ps)) {
1044 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->buf_len);
1045 if (str->buffer == NULL)
1049 p = (char *)str->buffer;
1051 dbg_rw_punival(charmode, name, depth, ps, q, p, str->buf_len);
1053 ps->data_offset += (str->buf_len * sizeof(uint16));
1058 /******************************************************************
1059 Stream a unicode string, length/buffer specified separately,
1060 in uint16 chars. The unicode string is already in little-endian format.
1061 ********************************************************************/
1063 bool prs_unistr2(bool charmode, const char *name, prs_struct *ps, int depth, UNISTR2 *str)
1066 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1070 /* If the string is empty, we don't have anything to stream */
1071 if (str->uni_str_len==0)
1074 if (UNMARSHALLING(ps)) {
1075 if (str->uni_str_len > str->uni_max_len) {
1078 if (str->uni_max_len) {
1079 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_max_len);
1080 if (str->buffer == NULL)
1087 p = (char *)str->buffer;
1089 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1091 ps->data_offset += (str->uni_str_len * sizeof(uint16));
1096 /******************************************************************
1097 Stream a unicode string, length/buffer specified separately,
1098 in uint16 chars. The unicode string is already in little-endian format.
1099 ********************************************************************/
1101 bool prs_unistr3(bool charmode, const char *name, UNISTR3 *str, prs_struct *ps, int depth)
1104 char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1108 if (UNMARSHALLING(ps)) {
1109 if (str->uni_str_len) {
1110 str->str.buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_str_len);
1111 if (str->str.buffer == NULL)
1114 str->str.buffer = NULL;
1118 p = (char *)str->str.buffer;
1120 dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1121 ps->data_offset += (str->uni_str_len * sizeof(uint16));
1126 /*******************************************************************
1127 Stream a unicode null-terminated string. As the string is already
1128 in little-endian format then do it as a stream of bytes.
1129 ********************************************************************/
1131 bool prs_unistr(const char *name, prs_struct *ps, int depth, UNISTR *str)
1133 unsigned int len = 0;
1134 unsigned char *p = (unsigned char *)str->buffer;
1140 if (MARSHALLING(ps)) {
1142 for(len = 0; str->buffer[len] != 0; len++)
1145 q = prs_mem_get(ps, (len+1)*2);
1151 for(len = 0; str->buffer[len] != 0; len++) {
1152 if(ps->bigendian_data) {
1153 /* swap bytes - p is little endian, q is big endian. */
1169 * even if the string is 'empty' (only an \0 char)
1170 * at this point the leading \0 hasn't been parsed.
1180 DEBUGADD(5,("%s%04x %s: ", tab_depth(5,depth), ps->data_offset, name));
1181 print_asc(5, (unsigned char*)start, 2*len);
1182 DEBUGADD(5, ("\n"));
1184 else { /* unmarshalling */
1186 uint32 alloc_len = 0;
1187 q = ps->data_p + prs_offset(ps);
1190 * Work out how much space we need and talloc it.
1192 max_len = (ps->buffer_size - ps->data_offset)/sizeof(uint16);
1194 /* the test of the value of *ptr helps to catch the circumstance
1195 where we have an emtpty (non-existent) string in the buffer */
1196 for ( ptr = (uint16 *)q; *ptr++ && (alloc_len <= max_len); alloc_len++)
1200 if (alloc_len < max_len)
1203 /* should we allocate anything at all? */
1204 str->buffer = PRS_ALLOC_MEM(ps,uint16,alloc_len);
1205 if ((str->buffer == NULL) && (alloc_len > 0))
1208 p = (unsigned char *)str->buffer;
1211 /* the (len < alloc_len) test is to prevent us from overwriting
1212 memory that is not ours...if we get that far, we have a non-null
1213 terminated string in the buffer and have messed up somewhere */
1214 while ((len < alloc_len) && (*(uint16 *)q != 0)) {
1215 if(ps->bigendian_data)
1217 /* swap bytes - q is big endian, p is little endian. */
1218 p[0] = (unsigned char)q[1];
1219 p[1] = (unsigned char)q[0];
1224 p[0] = (unsigned char)q[0];
1225 p[1] = (unsigned char)q[1];
1232 if (len < alloc_len) {
1233 /* NULL terminate the UNISTR */
1234 str->buffer[len++] = '\0';
1237 DEBUGADD(5,("%s%04x %s: ", tab_depth(5,depth), ps->data_offset, name));
1238 print_asc(5, (unsigned char*)str->buffer, 2*len);
1239 DEBUGADD(5, ("\n"));
1242 /* set the offset in the prs_struct; 'len' points to the
1243 terminiating NULL in the UNISTR so we need to go one more
1245 ps->data_offset += (len)*2;
1251 /*******************************************************************
1252 Stream a null-terminated string. len is strlen, and therefore does
1253 not include the null-termination character.
1254 ********************************************************************/
1256 bool prs_string(const char *name, prs_struct *ps, int depth, char *str, int max_buf_size)
1262 if (UNMARSHALLING(ps))
1263 len = strlen(&ps->data_p[ps->data_offset]);
1267 len = MIN(len, (max_buf_size-1));
1269 q = prs_mem_get(ps, len+1);
1273 for(i = 0; i < len; i++) {
1274 if (UNMARSHALLING(ps))
1280 /* The terminating null. */
1283 if (MARSHALLING(ps)) {
1287 ps->data_offset += len+1;
1289 dump_data(5+depth, (uint8 *)q, len);
1294 bool prs_string_alloc(const char *name, prs_struct *ps, int depth, const char **str)
1299 if (UNMARSHALLING(ps)) {
1300 len = strlen(&ps->data_p[ps->data_offset]);
1305 tmp_str = PRS_ALLOC_MEM(ps, char, len+1);
1307 if (tmp_str == NULL) {
1311 if (MARSHALLING(ps)) {
1312 strncpy(tmp_str, *str, len);
1315 if (!prs_string(name, ps, depth, tmp_str, len+1)) {
1323 /*******************************************************************
1324 prs_uint16 wrapper. Call this and it sets up a pointer to where the
1325 uint16 should be stored, or gets the size if reading.
1326 ********************************************************************/
1328 bool prs_uint16_pre(const char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
1330 *offset = ps->data_offset;
1331 if (UNMARSHALLING(ps)) {
1333 return prs_uint16(name, ps, depth, data16);
1335 char *q = prs_mem_get(ps, sizeof(uint16));
1338 ps->data_offset += sizeof(uint16);
1343 /*******************************************************************
1344 prs_uint16 wrapper. call this and it retrospectively stores the size.
1345 does nothing on reading, as that is already handled by ...._pre()
1346 ********************************************************************/
1348 bool prs_uint16_post(const char *name, prs_struct *ps, int depth, uint16 *data16,
1349 uint32 ptr_uint16, uint32 start_offset)
1351 if (MARSHALLING(ps)) {
1353 * Writing - temporarily move the offset pointer.
1355 uint16 data_size = ps->data_offset - start_offset;
1356 uint32 old_offset = ps->data_offset;
1358 ps->data_offset = ptr_uint16;
1359 if(!prs_uint16(name, ps, depth, &data_size)) {
1360 ps->data_offset = old_offset;
1363 ps->data_offset = old_offset;
1365 ps->data_offset = start_offset + (uint32)(*data16);
1370 /*******************************************************************
1371 prs_uint32 wrapper. Call this and it sets up a pointer to where the
1372 uint32 should be stored, or gets the size if reading.
1373 ********************************************************************/
1375 bool prs_uint32_pre(const char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
1377 *offset = ps->data_offset;
1378 if (UNMARSHALLING(ps) && (data32 != NULL)) {
1380 return prs_uint32(name, ps, depth, data32);
1382 ps->data_offset += sizeof(uint32);
1387 /*******************************************************************
1388 prs_uint32 wrapper. call this and it retrospectively stores the size.
1389 does nothing on reading, as that is already handled by ...._pre()
1390 ********************************************************************/
1392 bool prs_uint32_post(const char *name, prs_struct *ps, int depth, uint32 *data32,
1393 uint32 ptr_uint32, uint32 data_size)
1395 if (MARSHALLING(ps)) {
1397 * Writing - temporarily move the offset pointer.
1399 uint32 old_offset = ps->data_offset;
1400 ps->data_offset = ptr_uint32;
1401 if(!prs_uint32(name, ps, depth, &data_size)) {
1402 ps->data_offset = old_offset;
1405 ps->data_offset = old_offset;
1410 /* useful function to store a structure in rpc wire format */
1411 int tdb_prs_store(TDB_CONTEXT *tdb, TDB_DATA kbuf, prs_struct *ps)
1414 dbuf.dptr = (uint8 *)ps->data_p;
1415 dbuf.dsize = prs_offset(ps);
1416 return tdb_trans_store(tdb, kbuf, dbuf, TDB_REPLACE);
1419 /* useful function to fetch a structure into rpc wire format */
1420 int tdb_prs_fetch(TDB_CONTEXT *tdb, TDB_DATA kbuf, prs_struct *ps, TALLOC_CTX *mem_ctx)
1424 prs_init_empty(ps, mem_ctx, UNMARSHALL);
1426 dbuf = tdb_fetch(tdb, kbuf);
1430 prs_give_memory(ps, (char *)dbuf.dptr, dbuf.dsize, True);
1435 /*******************************************************************
1437 ********************************************************************/
1439 bool prs_hash1(prs_struct *ps, uint32 offset, int len)
1446 #ifdef DEBUG_PASSWORD
1447 DEBUG(100, ("prs_hash1\n"));
1448 dump_data(100, (uint8 *)ps->sess_key, 16);
1449 dump_data(100, (uint8 *)q, len);
1451 SamOEMhash((uchar *) q, (const unsigned char *)ps->sess_key, len);
1453 #ifdef DEBUG_PASSWORD
1454 dump_data(100, (uint8 *)q, len);
1460 /*******************************************************************
1461 Create a digest over the entire packet (including the data), and
1462 MD5 it with the session key.
1463 ********************************************************************/
1465 static void schannel_digest(struct schannel_auth_struct *a,
1466 enum pipe_auth_level auth_level,
1467 RPC_AUTH_SCHANNEL_CHK * verf,
1468 char *data, size_t data_len,
1469 uchar digest_final[16])
1471 uchar whole_packet_digest[16];
1473 struct MD5Context ctx3;
1477 /* verfiy the signature on the packet by MD5 over various bits */
1479 /* use our sequence number, which ensures the packet is not
1481 MD5Update(&ctx3, zeros, sizeof(zeros));
1482 MD5Update(&ctx3, verf->sig, sizeof(verf->sig));
1483 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1484 MD5Update(&ctx3, verf->confounder, sizeof(verf->confounder));
1486 MD5Update(&ctx3, (const unsigned char *)data, data_len);
1487 MD5Final(whole_packet_digest, &ctx3);
1488 dump_data_pw("whole_packet_digest:\n", whole_packet_digest, sizeof(whole_packet_digest));
1490 /* MD5 this result and the session key, to prove that
1491 only a valid client could had produced this */
1492 hmac_md5(a->sess_key, whole_packet_digest, sizeof(whole_packet_digest), digest_final);
1495 /*******************************************************************
1496 Calculate the key with which to encode the data payload
1497 ********************************************************************/
1499 static void schannel_get_sealing_key(struct schannel_auth_struct *a,
1500 RPC_AUTH_SCHANNEL_CHK *verf,
1501 uchar sealing_key[16])
1510 for (i = 0; i < sizeof(sess_kf0); i++) {
1511 sess_kf0[i] = a->sess_key[i] ^ 0xf0;
1514 dump_data_pw("sess_kf0:\n", sess_kf0, sizeof(sess_kf0));
1516 /* MD5 of sess_kf0 and 4 zero bytes */
1517 hmac_md5(sess_kf0, zeros, 0x4, digest2);
1518 dump_data_pw("digest2:\n", digest2, sizeof(digest2));
1520 /* MD5 of the above result, plus 8 bytes of sequence number */
1521 hmac_md5(digest2, verf->seq_num, sizeof(verf->seq_num), sealing_key);
1522 dump_data_pw("sealing_key:\n", sealing_key, 16);
1525 /*******************************************************************
1526 Encode or Decode the sequence number (which is symmetric)
1527 ********************************************************************/
1529 static void schannel_deal_with_seq_num(struct schannel_auth_struct *a,
1530 RPC_AUTH_SCHANNEL_CHK *verf)
1533 uchar sequence_key[16];
1538 hmac_md5(a->sess_key, zeros, sizeof(zeros), digest1);
1539 dump_data_pw("(sequence key) digest1:\n", digest1, sizeof(digest1));
1541 hmac_md5(digest1, verf->packet_digest, 8, sequence_key);
1543 dump_data_pw("sequence_key:\n", sequence_key, sizeof(sequence_key));
1545 dump_data_pw("seq_num (before):\n", verf->seq_num, sizeof(verf->seq_num));
1546 SamOEMhash(verf->seq_num, sequence_key, 8);
1547 dump_data_pw("seq_num (after):\n", verf->seq_num, sizeof(verf->seq_num));
1550 /*******************************************************************
1551 creates an RPC_AUTH_SCHANNEL_CHK structure.
1552 ********************************************************************/
1554 static bool init_rpc_auth_schannel_chk(RPC_AUTH_SCHANNEL_CHK * chk,
1556 const uchar packet_digest[8],
1557 const uchar seq_num[8], const uchar confounder[8])
1562 memcpy(chk->sig, sig, sizeof(chk->sig));
1563 memcpy(chk->packet_digest, packet_digest, sizeof(chk->packet_digest));
1564 memcpy(chk->seq_num, seq_num, sizeof(chk->seq_num));
1565 memcpy(chk->confounder, confounder, sizeof(chk->confounder));
1570 /*******************************************************************
1571 Encode a blob of data using the schannel alogrithm, also produceing
1572 a checksum over the original data. We currently only support
1573 signing and sealing togeather - the signing-only code is close, but not
1574 quite compatible with what MS does.
1575 ********************************************************************/
1577 void schannel_encode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1578 enum schannel_direction direction,
1579 RPC_AUTH_SCHANNEL_CHK * verf,
1580 char *data, size_t data_len)
1582 uchar digest_final[16];
1583 uchar confounder[8];
1585 static const uchar nullbytes[8] = { 0, };
1587 static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1588 static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1589 const uchar *schannel_sig = NULL;
1591 DEBUG(10,("SCHANNEL: schannel_encode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1593 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1594 schannel_sig = schannel_seal_sig;
1596 schannel_sig = schannel_sign_sig;
1599 /* fill the 'confounder' with random data */
1600 generate_random_buffer(confounder, sizeof(confounder));
1602 dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1604 RSIVAL(seq_num, 0, a->seq_num);
1606 switch (direction) {
1607 case SENDER_IS_INITIATOR:
1608 SIVAL(seq_num, 4, 0x80);
1610 case SENDER_IS_ACCEPTOR:
1611 SIVAL(seq_num, 4, 0x0);
1615 dump_data_pw("verf->seq_num:\n", seq_num, sizeof(verf->seq_num));
1617 init_rpc_auth_schannel_chk(verf, schannel_sig, nullbytes,
1618 seq_num, confounder);
1620 /* produce a digest of the packet to prove it's legit (before we seal it) */
1621 schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1622 memcpy(verf->packet_digest, digest_final, sizeof(verf->packet_digest));
1624 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1625 uchar sealing_key[16];
1627 /* get the key to encode the data with */
1628 schannel_get_sealing_key(a, verf, sealing_key);
1630 /* encode the verification data */
1631 dump_data_pw("verf->confounder:\n", verf->confounder, sizeof(verf->confounder));
1632 SamOEMhash(verf->confounder, sealing_key, 8);
1634 dump_data_pw("verf->confounder_enc:\n", verf->confounder, sizeof(verf->confounder));
1636 /* encode the packet payload */
1637 dump_data_pw("data:\n", (const unsigned char *)data, data_len);
1638 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1639 dump_data_pw("data_enc:\n", (const unsigned char *)data, data_len);
1642 /* encode the sequence number (key based on packet digest) */
1643 /* needs to be done after the sealing, as the original version
1644 is used in the sealing stuff... */
1645 schannel_deal_with_seq_num(a, verf);
1650 /*******************************************************************
1651 Decode a blob of data using the schannel alogrithm, also verifiying
1652 a checksum over the original data. We currently can verify signed messages,
1653 as well as decode sealed messages
1654 ********************************************************************/
1656 bool schannel_decode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1657 enum schannel_direction direction,
1658 RPC_AUTH_SCHANNEL_CHK * verf, char *data, size_t data_len)
1660 uchar digest_final[16];
1662 static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1663 static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1664 const uchar *schannel_sig = NULL;
1668 DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1670 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1671 schannel_sig = schannel_seal_sig;
1673 schannel_sig = schannel_sign_sig;
1676 /* Create the expected sequence number for comparison */
1677 RSIVAL(seq_num, 0, a->seq_num);
1679 switch (direction) {
1680 case SENDER_IS_INITIATOR:
1681 SIVAL(seq_num, 4, 0x80);
1683 case SENDER_IS_ACCEPTOR:
1684 SIVAL(seq_num, 4, 0x0);
1688 DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1689 dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1691 dump_data_pw("seq_num:\n", seq_num, sizeof(seq_num));
1693 /* extract the sequence number (key based on supplied packet digest) */
1694 /* needs to be done before the sealing, as the original version
1695 is used in the sealing stuff... */
1696 schannel_deal_with_seq_num(a, verf);
1698 if (memcmp(verf->seq_num, seq_num, sizeof(seq_num))) {
1699 /* don't even bother with the below if the sequence number is out */
1700 /* The sequence number is MD5'ed with a key based on the whole-packet
1701 digest, as supplied by the client. We check that it's a valid
1702 checksum after the decode, below
1704 DEBUG(2, ("schannel_decode: FAILED: packet sequence number:\n"));
1705 dump_data(2, verf->seq_num, sizeof(verf->seq_num));
1706 DEBUG(2, ("should be:\n"));
1707 dump_data(2, seq_num, sizeof(seq_num));
1712 if (memcmp(verf->sig, schannel_sig, sizeof(verf->sig))) {
1713 /* Validate that the other end sent the expected header */
1714 DEBUG(2, ("schannel_decode: FAILED: packet header:\n"));
1715 dump_data(2, verf->sig, sizeof(verf->sig));
1716 DEBUG(2, ("should be:\n"));
1717 dump_data(2, schannel_sig, sizeof(schannel_sig));
1721 if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1722 uchar sealing_key[16];
1724 /* get the key to extract the data with */
1725 schannel_get_sealing_key(a, verf, sealing_key);
1727 /* extract the verification data */
1728 dump_data_pw("verf->confounder:\n", verf->confounder,
1729 sizeof(verf->confounder));
1730 SamOEMhash(verf->confounder, sealing_key, 8);
1732 dump_data_pw("verf->confounder_dec:\n", verf->confounder,
1733 sizeof(verf->confounder));
1735 /* extract the packet payload */
1736 dump_data_pw("data :\n", (const unsigned char *)data, data_len);
1737 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1738 dump_data_pw("datadec:\n", (const unsigned char *)data, data_len);
1741 /* digest includes 'data' after unsealing */
1742 schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1744 dump_data_pw("Calculated digest:\n", digest_final,
1745 sizeof(digest_final));
1746 dump_data_pw("verf->packet_digest:\n", verf->packet_digest,
1747 sizeof(verf->packet_digest));
1749 /* compare - if the client got the same result as us, then
1750 it must know the session key */
1751 return (memcmp(digest_final, verf->packet_digest,
1752 sizeof(verf->packet_digest)) == 0);
1755 /*******************************************************************
1756 creates a new prs_struct containing a DATA_BLOB
1757 ********************************************************************/
1758 bool prs_init_data_blob(prs_struct *prs, DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
1760 if (!prs_init( prs, RPC_MAX_PDU_FRAG_LEN, mem_ctx, MARSHALL ))
1764 if (!prs_copy_data_in(prs, (char *)blob->data, blob->length))
1770 /*******************************************************************
1771 return the contents of a prs_struct in a DATA_BLOB
1772 ********************************************************************/
1773 bool prs_data_blob(prs_struct *prs, DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
1775 blob->length = prs_data_size(prs);
1776 blob->data = (uint8 *)TALLOC_ZERO_SIZE(mem_ctx, blob->length);
1778 /* set the pointer at the end of the buffer */
1779 prs_set_offset( prs, prs_data_size(prs) );
1781 if (!prs_copy_all_data_out((char *)blob->data, prs))