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
);
39 * Dump from the start of the prs to the current location.
41 void prs_dump_before(char *name
, int v
, prs_struct
*ps
)
43 prs_dump_region(name
, v
, ps
, 0, ps
->data_offset
);
48 * Dump everything from the start of the prs up to the current location.
50 void prs_dump_region(char *name
, int v
, prs_struct
*ps
,
51 int from_off
, int to_off
)
55 if (DEBUGLEVEL
< 50) return;
58 slprintf(fname
,sizeof(fname
)-1, "/tmp/%s_%d.%d.prs", name
, v
, i
);
60 slprintf(fname
,sizeof(fname
)-1, "/tmp/%s.%d.prs", name
, i
);
62 fd
= open(fname
, O_WRONLY
|O_CREAT
|O_EXCL
, 0644);
63 if (fd
!= -1 || errno
!= EEXIST
) break;
66 write(fd
, ps
->data_p
+ from_off
, to_off
- from_off
);
68 DEBUG(0,("created %s\n", fname
));
74 /*******************************************************************
75 debug output for parsing info.
77 XXXX side-effect of this function is to increase the debug depth XXXX
79 ********************************************************************/
80 void prs_debug(prs_struct
*ps
, int depth
, const char *desc
, const char *fn_name
)
82 DEBUG(5+depth
, ("%s%06x %s %s\n", tab_depth(depth
), ps
->data_offset
, fn_name
, desc
));
87 * Initialise an expandable parse structure.
89 * @param size Initial buffer size. If >0, a new buffer will be
90 * created with malloc().
92 * @return False if allocation fails, otherwise True.
94 BOOL
prs_init(prs_struct
*ps
, uint32 size
, TALLOC_CTX
*ctx
, BOOL io
)
98 ps
->bigendian_data
= RPC_LITTLE_ENDIAN
;
99 ps
->align
= RPC_PARSE_ALIGN
;
100 ps
->is_dynamic
= False
;
107 ps
->buffer_size
= size
;
108 if((ps
->data_p
= (char *)SMB_MALLOC((size_t)size
)) == NULL
) {
109 DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size
));
112 memset(ps
->data_p
, '\0', (size_t)size
);
113 ps
->is_dynamic
= True
; /* We own this memory. */
119 /*******************************************************************
120 Delete the memory in a parse structure - if we own it.
121 ********************************************************************/
123 void prs_mem_free(prs_struct
*ps
)
126 SAFE_FREE(ps
->data_p
);
127 ps
->is_dynamic
= False
;
132 /*******************************************************************
133 Clear the memory in a parse structure.
134 ********************************************************************/
136 void prs_mem_clear(prs_struct
*ps
)
139 memset(ps
->data_p
, '\0', (size_t)ps
->buffer_size
);
142 /*******************************************************************
143 Allocate memory when unmarshalling... Always zero clears.
144 ********************************************************************/
146 #if defined(PARANOID_MALLOC_CHECKER)
147 char *prs_alloc_mem_(prs_struct
*ps
, size_t size
, unsigned int count
)
149 char *prs_alloc_mem(prs_struct
*ps
, size_t size
, unsigned int count
)
155 /* We can't call the type-safe version here. */
156 #if defined(PARANOID_MALLOC_CHECKER)
157 ret
= talloc_zero_array_(ps
->mem_ctx
, size
, count
);
159 ret
= talloc_zero_array(ps
->mem_ctx
, size
, count
);
165 /*******************************************************************
166 Return the current talloc context we're using.
167 ********************************************************************/
169 TALLOC_CTX
*prs_get_mem_context(prs_struct
*ps
)
174 /*******************************************************************
175 Hand some already allocated memory to a prs_struct.
176 ********************************************************************/
178 void prs_give_memory(prs_struct
*ps
, char *buf
, uint32 size
, BOOL is_dynamic
)
180 ps
->is_dynamic
= is_dynamic
;
182 ps
->buffer_size
= size
;
185 /*******************************************************************
186 Take some memory back from a prs_struct.
187 ********************************************************************/
189 char *prs_take_memory(prs_struct
*ps
, uint32
*psize
)
191 char *ret
= ps
->data_p
;
193 *psize
= ps
->buffer_size
;
194 ps
->is_dynamic
= False
;
199 /*******************************************************************
200 Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
201 ********************************************************************/
203 BOOL
prs_set_buffer_size(prs_struct
*ps
, uint32 newsize
)
205 if (newsize
> ps
->buffer_size
)
206 return prs_force_grow(ps
, newsize
- ps
->buffer_size
);
208 if (newsize
< ps
->buffer_size
) {
209 char *new_data_p
= SMB_REALLOC(ps
->data_p
, newsize
);
210 /* if newsize is zero, Realloc acts like free() & returns NULL*/
211 if (new_data_p
== NULL
&& newsize
!= 0) {
212 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
213 (unsigned int)newsize
));
214 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno
)));
217 ps
->data_p
= new_data_p
;
218 ps
->buffer_size
= newsize
;
224 /*******************************************************************
225 Attempt, if needed, to grow a data buffer.
226 Also depends on the data stream mode (io).
227 ********************************************************************/
229 BOOL
prs_grow(prs_struct
*ps
, uint32 extra_space
)
234 ps
->grow_size
= MAX(ps
->grow_size
, ps
->data_offset
+ extra_space
);
236 if(ps
->data_offset
+ extra_space
<= ps
->buffer_size
)
240 * We cannot grow the buffer if we're not reading
241 * into the prs_struct, or if we don't own the memory.
244 if(UNMARSHALLING(ps
) || !ps
->is_dynamic
) {
245 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
246 (unsigned int)extra_space
));
251 * Decide how much extra space we really need.
254 extra_space
-= (ps
->buffer_size
- ps
->data_offset
);
255 if(ps
->buffer_size
== 0) {
257 * Ensure we have at least a PDU's length, or extra_space, whichever
261 new_size
= MAX(MAX_PDU_FRAG_LEN
,extra_space
);
263 if((new_data
= SMB_MALLOC(new_size
)) == NULL
) {
264 DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size
));
267 memset(new_data
, '\0', (size_t)new_size
);
270 * If the current buffer size is bigger than the space needed, just
271 * double it, else add extra_space.
273 new_size
= MAX(ps
->buffer_size
*2, ps
->buffer_size
+ extra_space
);
275 if ((new_data
= SMB_REALLOC(ps
->data_p
, new_size
)) == NULL
) {
276 DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
277 (unsigned int)new_size
));
281 memset(&new_data
[ps
->buffer_size
], '\0', (size_t)(new_size
- ps
->buffer_size
));
283 ps
->buffer_size
= new_size
;
284 ps
->data_p
= new_data
;
289 /*******************************************************************
290 Attempt to force a data buffer to grow by len bytes.
291 This is only used when appending more data onto a prs_struct
292 when reading an rpc reply, before unmarshalling it.
293 ********************************************************************/
295 BOOL
prs_force_grow(prs_struct
*ps
, uint32 extra_space
)
297 uint32 new_size
= ps
->buffer_size
+ extra_space
;
300 if(!UNMARSHALLING(ps
) || !ps
->is_dynamic
) {
301 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
302 (unsigned int)extra_space
));
306 if((new_data
= SMB_REALLOC(ps
->data_p
, new_size
)) == NULL
) {
307 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
308 (unsigned int)new_size
));
312 memset(&new_data
[ps
->buffer_size
], '\0', (size_t)(new_size
- ps
->buffer_size
));
314 ps
->buffer_size
= new_size
;
315 ps
->data_p
= new_data
;
320 /*******************************************************************
321 Get the data pointer (external interface).
322 ********************************************************************/
324 char *prs_data_p(prs_struct
*ps
)
329 /*******************************************************************
330 Get the current data size (external interface).
331 ********************************************************************/
333 uint32
prs_data_size(prs_struct
*ps
)
335 return ps
->buffer_size
;
338 /*******************************************************************
339 Fetch the current offset (external interface).
340 ********************************************************************/
342 uint32
prs_offset(prs_struct
*ps
)
344 return ps
->data_offset
;
347 /*******************************************************************
348 Set the current offset (external interface).
349 ********************************************************************/
351 BOOL
prs_set_offset(prs_struct
*ps
, uint32 offset
)
353 if(offset
<= ps
->data_offset
) {
354 ps
->data_offset
= offset
;
358 if(!prs_grow(ps
, offset
- ps
->data_offset
))
361 ps
->data_offset
= offset
;
365 /*******************************************************************
366 Append the data from one parse_struct into another.
367 ********************************************************************/
369 BOOL
prs_append_prs_data(prs_struct
*dst
, prs_struct
*src
)
371 if (prs_offset(src
) == 0)
374 if(!prs_grow(dst
, prs_offset(src
)))
377 memcpy(&dst
->data_p
[dst
->data_offset
], src
->data_p
, (size_t)prs_offset(src
));
378 dst
->data_offset
+= prs_offset(src
);
383 /*******************************************************************
384 Append some data from one parse_struct into another.
385 ********************************************************************/
387 BOOL
prs_append_some_prs_data(prs_struct
*dst
, prs_struct
*src
, int32 start
, uint32 len
)
392 if(!prs_grow(dst
, len
))
395 memcpy(&dst
->data_p
[dst
->data_offset
], src
->data_p
+ start
, (size_t)len
);
396 dst
->data_offset
+= len
;
401 /*******************************************************************
402 Append the data from a buffer into a parse_struct.
403 ********************************************************************/
405 BOOL
prs_copy_data_in(prs_struct
*dst
, char *src
, uint32 len
)
410 if(!prs_grow(dst
, len
))
413 memcpy(&dst
->data_p
[dst
->data_offset
], src
, (size_t)len
);
414 dst
->data_offset
+= len
;
419 /*******************************************************************
420 Copy some data from a parse_struct into a buffer.
421 ********************************************************************/
423 BOOL
prs_copy_data_out(char *dst
, prs_struct
*src
, uint32 len
)
428 if(!prs_mem_get(src
, len
))
431 memcpy(dst
, &src
->data_p
[src
->data_offset
], (size_t)len
);
432 src
->data_offset
+= len
;
437 /*******************************************************************
438 Copy all the data from a parse_struct into a buffer.
439 ********************************************************************/
441 BOOL
prs_copy_all_data_out(char *dst
, prs_struct
*src
)
443 uint32 len
= prs_offset(src
);
448 prs_set_offset(src
, 0);
449 return prs_copy_data_out(dst
, src
, len
);
452 /*******************************************************************
453 Set the data as X-endian (external interface).
454 ********************************************************************/
456 void prs_set_endian_data(prs_struct
*ps
, BOOL endian
)
458 ps
->bigendian_data
= endian
;
461 /*******************************************************************
462 Align a the data_len to a multiple of align bytes - filling with
464 ********************************************************************/
466 BOOL
prs_align(prs_struct
*ps
)
468 uint32 mod
= ps
->data_offset
& (ps
->align
-1);
470 if (ps
->align
!= 0 && mod
!= 0) {
471 uint32 extra_space
= (ps
->align
- mod
);
472 if(!prs_grow(ps
, extra_space
))
474 memset(&ps
->data_p
[ps
->data_offset
], '\0', (size_t)extra_space
);
475 ps
->data_offset
+= extra_space
;
481 /******************************************************************
482 Align on a 2 byte boundary
483 *****************************************************************/
485 BOOL
prs_align_uint16(prs_struct
*ps
)
488 uint8 old_align
= ps
->align
;
492 ps
->align
= old_align
;
497 /******************************************************************
498 Align on a 8 byte boundary
499 *****************************************************************/
501 BOOL
prs_align_uint64(prs_struct
*ps
)
504 uint8 old_align
= ps
->align
;
508 ps
->align
= old_align
;
513 /*******************************************************************
514 Align only if required (for the unistr2 string mainly)
515 ********************************************************************/
517 BOOL
prs_align_needed(prs_struct
*ps
, uint32 needed
)
522 return prs_align(ps
);
525 /*******************************************************************
526 Ensure we can read/write to a given offset.
527 ********************************************************************/
529 char *prs_mem_get(prs_struct
*ps
, uint32 extra_size
)
531 if(UNMARSHALLING(ps
)) {
533 * If reading, ensure that we can read the requested size item.
535 if (ps
->data_offset
+ extra_size
> ps
->buffer_size
) {
536 DEBUG(0,("prs_mem_get: reading data of size %u would overrun buffer.\n",
537 (unsigned int)extra_size
));
542 * Writing - grow the buffer if needed.
544 if(!prs_grow(ps
, extra_size
))
547 return &ps
->data_p
[ps
->data_offset
];
550 /*******************************************************************
551 Change the struct type.
552 ********************************************************************/
554 void prs_switch_type(prs_struct
*ps
, BOOL io
)
556 if ((ps
->io
^ io
) == True
)
560 /*******************************************************************
561 Force a prs_struct to be dynamic even when it's size is 0.
562 ********************************************************************/
564 void prs_force_dynamic(prs_struct
*ps
)
569 /*******************************************************************
571 ********************************************************************/
573 BOOL
prs_uint8(const char *name
, prs_struct
*ps
, int depth
, uint8
*data8
)
575 char *q
= prs_mem_get(ps
, 1);
579 if (UNMARSHALLING(ps
))
584 DEBUG(5,("%s%04x %s: %02x\n", tab_depth(depth
), ps
->data_offset
, name
, *data8
));
586 ps
->data_offset
+= 1;
591 /*******************************************************************
593 ********************************************************************/
595 BOOL
prs_uint16(const char *name
, prs_struct
*ps
, int depth
, uint16
*data16
)
597 char *q
= prs_mem_get(ps
, sizeof(uint16
));
601 if (UNMARSHALLING(ps
)) {
602 if (ps
->bigendian_data
)
603 *data16
= RSVAL(q
,0);
607 if (ps
->bigendian_data
)
613 DEBUG(5,("%s%04x %s: %04x\n", tab_depth(depth
), ps
->data_offset
, name
, *data16
));
615 ps
->data_offset
+= sizeof(uint16
);
620 /*******************************************************************
622 ********************************************************************/
624 BOOL
prs_uint32(const char *name
, prs_struct
*ps
, int depth
, uint32
*data32
)
626 char *q
= prs_mem_get(ps
, sizeof(uint32
));
630 if (UNMARSHALLING(ps
)) {
631 if (ps
->bigendian_data
)
632 *data32
= RIVAL(q
,0);
636 if (ps
->bigendian_data
)
642 DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth
), ps
->data_offset
, name
, *data32
));
644 ps
->data_offset
+= sizeof(uint32
);
649 /*******************************************************************
651 ********************************************************************/
653 BOOL
prs_ntstatus(const char *name
, prs_struct
*ps
, int depth
, NTSTATUS
*status
)
655 char *q
= prs_mem_get(ps
, sizeof(uint32
));
659 if (UNMARSHALLING(ps
)) {
660 if (ps
->bigendian_data
)
661 *status
= NT_STATUS(RIVAL(q
,0));
663 *status
= NT_STATUS(IVAL(q
,0));
665 if (ps
->bigendian_data
)
666 RSIVAL(q
,0,NT_STATUS_V(*status
));
668 SIVAL(q
,0,NT_STATUS_V(*status
));
671 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth
), ps
->data_offset
, name
,
672 nt_errstr(*status
)));
674 ps
->data_offset
+= sizeof(uint32
);
679 /*******************************************************************
681 ********************************************************************/
683 BOOL
prs_werror(const char *name
, prs_struct
*ps
, int depth
, WERROR
*status
)
685 char *q
= prs_mem_get(ps
, sizeof(uint32
));
689 if (UNMARSHALLING(ps
)) {
690 if (ps
->bigendian_data
)
691 *status
= W_ERROR(RIVAL(q
,0));
693 *status
= W_ERROR(IVAL(q
,0));
695 if (ps
->bigendian_data
)
696 RSIVAL(q
,0,W_ERROR_V(*status
));
698 SIVAL(q
,0,W_ERROR_V(*status
));
701 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth
), ps
->data_offset
, name
,
702 dos_errstr(*status
)));
704 ps
->data_offset
+= sizeof(uint32
);
710 /******************************************************************
711 Stream an array of uint8s. Length is number of uint8s.
712 ********************************************************************/
714 BOOL
prs_uint8s(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint8
*data8s
, int len
)
717 char *q
= prs_mem_get(ps
, len
);
721 if (UNMARSHALLING(ps
)) {
722 for (i
= 0; i
< len
; i
++)
723 data8s
[i
] = CVAL(q
,i
);
725 for (i
= 0; i
< len
; i
++)
726 SCVAL(q
, i
, data8s
[i
]);
729 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
,name
));
731 print_asc(5, (unsigned char*)data8s
, len
);
733 for (i
= 0; i
< len
; i
++)
734 DEBUG(5,("%02x ", data8s
[i
]));
738 ps
->data_offset
+= len
;
743 /******************************************************************
744 Stream an array of uint16s. Length is number of uint16s.
745 ********************************************************************/
747 BOOL
prs_uint16s(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint16
*data16s
, int len
)
750 char *q
= prs_mem_get(ps
, len
* sizeof(uint16
));
754 if (UNMARSHALLING(ps
)) {
755 if (ps
->bigendian_data
) {
756 for (i
= 0; i
< len
; i
++)
757 data16s
[i
] = RSVAL(q
, 2*i
);
759 for (i
= 0; i
< len
; i
++)
760 data16s
[i
] = SVAL(q
, 2*i
);
763 if (ps
->bigendian_data
) {
764 for (i
= 0; i
< len
; i
++)
765 RSSVAL(q
, 2*i
, data16s
[i
]);
767 for (i
= 0; i
< len
; i
++)
768 SSVAL(q
, 2*i
, data16s
[i
]);
772 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
774 print_asc(5, (unsigned char*)data16s
, 2*len
);
776 for (i
= 0; i
< len
; i
++)
777 DEBUG(5,("%04x ", data16s
[i
]));
781 ps
->data_offset
+= (len
* sizeof(uint16
));
786 /******************************************************************
787 Start using a function for streaming unicode chars. If unmarshalling,
788 output must be little-endian, if marshalling, input must be little-endian.
789 ********************************************************************/
791 static void dbg_rw_punival(BOOL charmode
, const char *name
, int depth
, prs_struct
*ps
,
792 char *in_buf
, char *out_buf
, int len
)
796 if (UNMARSHALLING(ps
)) {
797 if (ps
->bigendian_data
) {
798 for (i
= 0; i
< len
; i
++)
799 SSVAL(out_buf
,2*i
,RSVAL(in_buf
, 2*i
));
801 for (i
= 0; i
< len
; i
++)
802 SSVAL(out_buf
, 2*i
, SVAL(in_buf
, 2*i
));
805 if (ps
->bigendian_data
) {
806 for (i
= 0; i
< len
; i
++)
807 RSSVAL(in_buf
, 2*i
, SVAL(out_buf
,2*i
));
809 for (i
= 0; i
< len
; i
++)
810 SSVAL(in_buf
, 2*i
, SVAL(out_buf
,2*i
));
814 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
816 print_asc(5, (unsigned char*)out_buf
, 2*len
);
818 for (i
= 0; i
< len
; i
++)
819 DEBUG(5,("%04x ", out_buf
[i
]));
824 /******************************************************************
825 Stream a unistr. Always little endian.
826 ********************************************************************/
828 BOOL
prs_uint16uni(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint16
*data16s
, int len
)
830 char *q
= prs_mem_get(ps
, len
* sizeof(uint16
));
834 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, (char *)data16s
, len
);
835 ps
->data_offset
+= (len
* sizeof(uint16
));
840 /******************************************************************
841 Stream an array of uint32s. Length is number of uint32s.
842 ********************************************************************/
844 BOOL
prs_uint32s(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint32
*data32s
, int len
)
847 char *q
= prs_mem_get(ps
, len
* sizeof(uint32
));
851 if (UNMARSHALLING(ps
)) {
852 if (ps
->bigendian_data
) {
853 for (i
= 0; i
< len
; i
++)
854 data32s
[i
] = RIVAL(q
, 4*i
);
856 for (i
= 0; i
< len
; i
++)
857 data32s
[i
] = IVAL(q
, 4*i
);
860 if (ps
->bigendian_data
) {
861 for (i
= 0; i
< len
; i
++)
862 RSIVAL(q
, 4*i
, data32s
[i
]);
864 for (i
= 0; i
< len
; i
++)
865 SIVAL(q
, 4*i
, data32s
[i
]);
869 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
871 print_asc(5, (unsigned char*)data32s
, 4*len
);
873 for (i
= 0; i
< len
; i
++)
874 DEBUG(5,("%08x ", data32s
[i
]));
878 ps
->data_offset
+= (len
* sizeof(uint32
));
883 /******************************************************************
884 Stream an array of unicode string, length/buffer specified separately,
885 in uint16 chars. The unicode string is already in little-endian format.
886 ********************************************************************/
888 BOOL
prs_buffer5(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, BUFFER5
*str
)
891 char *q
= prs_mem_get(ps
, str
->buf_len
* sizeof(uint16
));
895 if (UNMARSHALLING(ps
)) {
896 str
->buffer
= PRS_ALLOC_MEM(ps
,uint16
,str
->buf_len
);
897 if (str
->buffer
== NULL
)
901 /* If the string is empty, we don't have anything to stream */
905 p
= (char *)str
->buffer
;
907 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->buf_len
);
909 ps
->data_offset
+= (str
->buf_len
* sizeof(uint16
));
914 /******************************************************************
915 Stream a "not" unicode string, length/buffer specified separately,
916 in byte chars. String is in little-endian format.
917 ********************************************************************/
919 BOOL
prs_buffer2(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, BUFFER2
*str
)
922 char *q
= prs_mem_get(ps
, str
->buf_len
);
926 if (UNMARSHALLING(ps
)) {
927 if ( str
->buf_len
) {
928 str
->buffer
= PRS_ALLOC_MEM(ps
, uint16
, str
->buf_len
);
929 if ( str
->buffer
== NULL
)
934 p
= (char *)str
->buffer
;
936 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->buf_len
/2);
937 ps
->data_offset
+= str
->buf_len
;
942 /******************************************************************
943 Stream a string, length/buffer specified separately,
945 ********************************************************************/
947 BOOL
prs_string2(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, STRING2
*str
)
950 char *q
= prs_mem_get(ps
, str
->str_max_len
);
954 if (UNMARSHALLING(ps
)) {
955 str
->buffer
= PRS_ALLOC_MEM(ps
,unsigned char, str
->str_max_len
);
956 if (str
->buffer
== NULL
)
960 if (UNMARSHALLING(ps
)) {
961 for (i
= 0; i
< str
->str_str_len
; i
++)
962 str
->buffer
[i
] = CVAL(q
,i
);
964 for (i
= 0; i
< str
->str_str_len
; i
++)
965 SCVAL(q
, i
, str
->buffer
[i
]);
968 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
970 print_asc(5, (unsigned char*)str
->buffer
, str
->str_str_len
);
972 for (i
= 0; i
< str
->str_str_len
; i
++)
973 DEBUG(5,("%02x ", str
->buffer
[i
]));
977 ps
->data_offset
+= str
->str_str_len
;
982 /******************************************************************
983 Stream a unicode string, length/buffer specified separately,
984 in uint16 chars. The unicode string is already in little-endian format.
985 ********************************************************************/
987 BOOL
prs_unistr2(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, UNISTR2
*str
)
990 char *q
= prs_mem_get(ps
, str
->uni_str_len
* sizeof(uint16
));
994 /* If the string is empty, we don't have anything to stream */
995 if (str
->uni_str_len
==0)
998 if (UNMARSHALLING(ps
)) {
999 str
->buffer
= PRS_ALLOC_MEM(ps
,uint16
,str
->uni_max_len
);
1000 if (str
->buffer
== NULL
)
1004 p
= (char *)str
->buffer
;
1006 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->uni_str_len
);
1008 ps
->data_offset
+= (str
->uni_str_len
* sizeof(uint16
));
1013 /******************************************************************
1014 Stream a unicode string, length/buffer specified separately,
1015 in uint16 chars. The unicode string is already in little-endian format.
1016 ********************************************************************/
1018 BOOL
prs_unistr3(BOOL charmode
, const char *name
, UNISTR3
*str
, prs_struct
*ps
, int depth
)
1021 char *q
= prs_mem_get(ps
, str
->uni_str_len
* sizeof(uint16
));
1025 if (UNMARSHALLING(ps
)) {
1026 str
->str
.buffer
= PRS_ALLOC_MEM(ps
,uint16
,str
->uni_str_len
);
1027 if (str
->str
.buffer
== NULL
)
1031 p
= (char *)str
->str
.buffer
;
1033 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->uni_str_len
);
1034 ps
->data_offset
+= (str
->uni_str_len
* sizeof(uint16
));
1039 /*******************************************************************
1040 Stream a unicode null-terminated string. As the string is already
1041 in little-endian format then do it as a stream of bytes.
1042 ********************************************************************/
1044 BOOL
prs_unistr(const char *name
, prs_struct
*ps
, int depth
, UNISTR
*str
)
1046 unsigned int len
= 0;
1047 unsigned char *p
= (unsigned char *)str
->buffer
;
1053 if (MARSHALLING(ps
)) {
1055 for(len
= 0; str
->buffer
[len
] != 0; len
++)
1058 q
= prs_mem_get(ps
, (len
+1)*2);
1064 for(len
= 0; str
->buffer
[len
] != 0; len
++)
1066 if(ps
->bigendian_data
)
1068 /* swap bytes - p is little endian, q is big endian. */
1084 * even if the string is 'empty' (only an \0 char)
1085 * at this point the leading \0 hasn't been parsed.
1095 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
1096 print_asc(5, (unsigned char*)start
, 2*len
);
1099 else { /* unmarshalling */
1101 uint32 alloc_len
= 0;
1102 q
= ps
->data_p
+ prs_offset(ps
);
1105 * Work out how much space we need and talloc it.
1107 max_len
= (ps
->buffer_size
- ps
->data_offset
)/sizeof(uint16
);
1109 /* the test of the value of *ptr helps to catch the circumstance
1110 where we have an emtpty (non-existent) string in the buffer */
1111 for ( ptr
= (uint16
*)q
; *ptr
++ && (alloc_len
<= max_len
); alloc_len
++)
1115 if (alloc_len
< max_len
)
1118 /* should we allocate anything at all? */
1119 str
->buffer
= PRS_ALLOC_MEM(ps
,uint16
,alloc_len
);
1120 if ((str
->buffer
== NULL
) && (alloc_len
> 0))
1123 p
= (unsigned char *)str
->buffer
;
1126 /* the (len < alloc_len) test is to prevent us from overwriting
1127 memory that is not ours...if we get that far, we have a non-null
1128 terminated string in the buffer and have messed up somewhere */
1129 while ((len
< alloc_len
) && (*(uint16
*)q
!= 0))
1131 if(ps
->bigendian_data
)
1133 /* swap bytes - q is big endian, p is little endian. */
1134 p
[0] = (unsigned char)q
[1];
1135 p
[1] = (unsigned char)q
[0];
1140 p
[0] = (unsigned char)q
[0];
1141 p
[1] = (unsigned char)q
[1];
1148 if (len
< alloc_len
)
1150 /* NULL terminate the UNISTR */
1151 str
->buffer
[len
++] = '\0';
1154 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
1155 print_asc(5, (unsigned char*)str
->buffer
, 2*len
);
1159 /* set the offset in the prs_struct; 'len' points to the
1160 terminiating NULL in the UNISTR so we need to go one more
1162 ps
->data_offset
+= (len
)*2;
1168 /*******************************************************************
1169 Stream a null-terminated string. len is strlen, and therefore does
1170 not include the null-termination character.
1171 ********************************************************************/
1173 BOOL
prs_string(const char *name
, prs_struct
*ps
, int depth
, char *str
, int max_buf_size
)
1179 if (UNMARSHALLING(ps
))
1180 len
= strlen(&ps
->data_p
[ps
->data_offset
]);
1184 len
= MIN(len
, (max_buf_size
-1));
1186 q
= prs_mem_get(ps
, len
+1);
1190 for(i
= 0; i
< len
; i
++) {
1191 if (UNMARSHALLING(ps
))
1197 /* The terminating null. */
1200 if (MARSHALLING(ps
)) {
1204 ps
->data_offset
+= len
+1;
1206 dump_data(5+depth
, q
, len
);
1211 /*******************************************************************
1212 prs_uint16 wrapper. Call this and it sets up a pointer to where the
1213 uint16 should be stored, or gets the size if reading.
1214 ********************************************************************/
1216 BOOL
prs_uint16_pre(const char *name
, prs_struct
*ps
, int depth
, uint16
*data16
, uint32
*offset
)
1218 *offset
= ps
->data_offset
;
1219 if (UNMARSHALLING(ps
)) {
1221 return prs_uint16(name
, ps
, depth
, data16
);
1223 char *q
= prs_mem_get(ps
, sizeof(uint16
));
1226 ps
->data_offset
+= sizeof(uint16
);
1231 /*******************************************************************
1232 prs_uint16 wrapper. call this and it retrospectively stores the size.
1233 does nothing on reading, as that is already handled by ...._pre()
1234 ********************************************************************/
1236 BOOL
prs_uint16_post(const char *name
, prs_struct
*ps
, int depth
, uint16
*data16
,
1237 uint32 ptr_uint16
, uint32 start_offset
)
1239 if (MARSHALLING(ps
)) {
1241 * Writing - temporarily move the offset pointer.
1243 uint16 data_size
= ps
->data_offset
- start_offset
;
1244 uint32 old_offset
= ps
->data_offset
;
1246 ps
->data_offset
= ptr_uint16
;
1247 if(!prs_uint16(name
, ps
, depth
, &data_size
)) {
1248 ps
->data_offset
= old_offset
;
1251 ps
->data_offset
= old_offset
;
1253 ps
->data_offset
= start_offset
+ (uint32
)(*data16
);
1258 /*******************************************************************
1259 prs_uint32 wrapper. Call this and it sets up a pointer to where the
1260 uint32 should be stored, or gets the size if reading.
1261 ********************************************************************/
1263 BOOL
prs_uint32_pre(const char *name
, prs_struct
*ps
, int depth
, uint32
*data32
, uint32
*offset
)
1265 *offset
= ps
->data_offset
;
1266 if (UNMARSHALLING(ps
) && (data32
!= NULL
)) {
1268 return prs_uint32(name
, ps
, depth
, data32
);
1270 ps
->data_offset
+= sizeof(uint32
);
1275 /*******************************************************************
1276 prs_uint32 wrapper. call this and it retrospectively stores the size.
1277 does nothing on reading, as that is already handled by ...._pre()
1278 ********************************************************************/
1280 BOOL
prs_uint32_post(const char *name
, prs_struct
*ps
, int depth
, uint32
*data32
,
1281 uint32 ptr_uint32
, uint32 data_size
)
1283 if (MARSHALLING(ps
)) {
1285 * Writing - temporarily move the offset pointer.
1287 uint32 old_offset
= ps
->data_offset
;
1288 ps
->data_offset
= ptr_uint32
;
1289 if(!prs_uint32(name
, ps
, depth
, &data_size
)) {
1290 ps
->data_offset
= old_offset
;
1293 ps
->data_offset
= old_offset
;
1298 /* useful function to store a structure in rpc wire format */
1299 int tdb_prs_store(TDB_CONTEXT
*tdb
, char *keystr
, prs_struct
*ps
)
1301 TDB_DATA kbuf
, dbuf
;
1303 kbuf
.dsize
= strlen(keystr
)+1;
1304 dbuf
.dptr
= ps
->data_p
;
1305 dbuf
.dsize
= prs_offset(ps
);
1306 return tdb_store(tdb
, kbuf
, dbuf
, TDB_REPLACE
);
1309 /* useful function to fetch a structure into rpc wire format */
1310 int tdb_prs_fetch(TDB_CONTEXT
*tdb
, char *keystr
, prs_struct
*ps
, TALLOC_CTX
*mem_ctx
)
1312 TDB_DATA kbuf
, dbuf
;
1314 kbuf
.dsize
= strlen(keystr
)+1;
1316 dbuf
= tdb_fetch(tdb
, kbuf
);
1320 prs_init(ps
, 0, mem_ctx
, UNMARSHALL
);
1321 prs_give_memory(ps
, dbuf
.dptr
, dbuf
.dsize
, True
);
1326 /*******************************************************************
1328 ********************************************************************/
1329 BOOL
prs_hash1(prs_struct
*ps
, uint32 offset
, uint8 sess_key
[16], int len
)
1336 #ifdef DEBUG_PASSWORD
1337 DEBUG(100, ("prs_hash1\n"));
1338 dump_data(100, sess_key
, 16);
1339 dump_data(100, q
, len
);
1341 SamOEMhash((uchar
*) q
, sess_key
, len
);
1343 #ifdef DEBUG_PASSWORD
1344 dump_data(100, q
, len
);
1351 /*******************************************************************
1352 Create a digest over the entire packet (including the data), and
1353 MD5 it with the session key.
1354 ********************************************************************/
1355 static void netsec_digest(struct netsec_auth_struct
*a
,
1357 RPC_AUTH_NETSEC_CHK
* verf
,
1358 char *data
, size_t data_len
,
1359 uchar digest_final
[16])
1361 uchar whole_packet_digest
[16];
1362 static uchar zeros
[4];
1363 struct MD5Context ctx3
;
1365 /* verfiy the signature on the packet by MD5 over various bits */
1367 /* use our sequence number, which ensures the packet is not
1369 MD5Update(&ctx3
, zeros
, sizeof(zeros
));
1370 MD5Update(&ctx3
, verf
->sig
, sizeof(verf
->sig
));
1371 if (auth_flags
& AUTH_PIPE_SEAL
) {
1372 MD5Update(&ctx3
, verf
->confounder
, sizeof(verf
->confounder
));
1374 MD5Update(&ctx3
, (const unsigned char *)data
, data_len
);
1375 MD5Final(whole_packet_digest
, &ctx3
);
1376 dump_data_pw("whole_packet_digest:\n", whole_packet_digest
, sizeof(whole_packet_digest
));
1378 /* MD5 this result and the session key, to prove that
1379 only a valid client could had produced this */
1380 hmac_md5(a
->sess_key
, whole_packet_digest
, sizeof(whole_packet_digest
), digest_final
);
1383 /*******************************************************************
1384 Calculate the key with which to encode the data payload
1385 ********************************************************************/
1386 static void netsec_get_sealing_key(struct netsec_auth_struct
*a
,
1387 RPC_AUTH_NETSEC_CHK
*verf
,
1388 uchar sealing_key
[16])
1390 static uchar zeros
[4];
1395 for (i
= 0; i
< sizeof(sess_kf0
); i
++) {
1396 sess_kf0
[i
] = a
->sess_key
[i
] ^ 0xf0;
1399 dump_data_pw("sess_kf0:\n", sess_kf0
, sizeof(sess_kf0
));
1401 /* MD5 of sess_kf0 and 4 zero bytes */
1402 hmac_md5(sess_kf0
, zeros
, 0x4, digest2
);
1403 dump_data_pw("digest2:\n", digest2
, sizeof(digest2
));
1405 /* MD5 of the above result, plus 8 bytes of sequence number */
1406 hmac_md5(digest2
, verf
->seq_num
, sizeof(verf
->seq_num
), sealing_key
);
1407 dump_data_pw("sealing_key:\n", sealing_key
, 16);
1410 /*******************************************************************
1411 Encode or Decode the sequence number (which is symmetric)
1412 ********************************************************************/
1413 static void netsec_deal_with_seq_num(struct netsec_auth_struct
*a
,
1414 RPC_AUTH_NETSEC_CHK
*verf
)
1416 static uchar zeros
[4];
1417 uchar sequence_key
[16];
1420 hmac_md5(a
->sess_key
, zeros
, sizeof(zeros
), digest1
);
1421 dump_data_pw("(sequence key) digest1:\n", digest1
, sizeof(digest1
));
1423 hmac_md5(digest1
, verf
->packet_digest
, 8, sequence_key
);
1425 dump_data_pw("sequence_key:\n", sequence_key
, sizeof(sequence_key
));
1427 dump_data_pw("seq_num (before):\n", verf
->seq_num
, sizeof(verf
->seq_num
));
1428 SamOEMhash(verf
->seq_num
, sequence_key
, 8);
1429 dump_data_pw("seq_num (after):\n", verf
->seq_num
, sizeof(verf
->seq_num
));
1432 /*******************************************************************
1433 creates an RPC_AUTH_NETSEC_CHK structure.
1434 ********************************************************************/
1435 static BOOL
init_rpc_auth_netsec_chk(RPC_AUTH_NETSEC_CHK
* chk
,
1437 const uchar packet_digest
[8],
1438 const uchar seq_num
[8], const uchar confounder
[8])
1443 memcpy(chk
->sig
, sig
, sizeof(chk
->sig
));
1444 memcpy(chk
->packet_digest
, packet_digest
, sizeof(chk
->packet_digest
));
1445 memcpy(chk
->seq_num
, seq_num
, sizeof(chk
->seq_num
));
1446 memcpy(chk
->confounder
, confounder
, sizeof(chk
->confounder
));
1452 /*******************************************************************
1453 Encode a blob of data using the netsec (schannel) alogrithm, also produceing
1454 a checksum over the original data. We currently only support
1455 signing and sealing togeather - the signing-only code is close, but not
1456 quite compatible with what MS does.
1457 ********************************************************************/
1458 void netsec_encode(struct netsec_auth_struct
*a
, int auth_flags
,
1459 enum netsec_direction direction
,
1460 RPC_AUTH_NETSEC_CHK
* verf
,
1461 char *data
, size_t data_len
)
1463 uchar digest_final
[16];
1464 uchar confounder
[8];
1466 static const uchar nullbytes
[8];
1468 static const uchar netsec_seal_sig
[8] = NETSEC_SEAL_SIGNATURE
;
1469 static const uchar netsec_sign_sig
[8] = NETSEC_SIGN_SIGNATURE
;
1470 const uchar
*netsec_sig
= NULL
;
1472 DEBUG(10,("SCHANNEL: netsec_encode seq_num=%d data_len=%lu\n", a
->seq_num
, (unsigned long)data_len
));
1474 if (auth_flags
& AUTH_PIPE_SEAL
) {
1475 netsec_sig
= netsec_seal_sig
;
1476 } else if (auth_flags
& AUTH_PIPE_SIGN
) {
1477 netsec_sig
= netsec_sign_sig
;
1480 /* fill the 'confounder' with random data */
1481 generate_random_buffer(confounder
, sizeof(confounder
));
1483 dump_data_pw("a->sess_key:\n", a
->sess_key
, sizeof(a
->sess_key
));
1485 RSIVAL(seq_num
, 0, a
->seq_num
);
1487 switch (direction
) {
1488 case SENDER_IS_INITIATOR
:
1489 SIVAL(seq_num
, 4, 0x80);
1491 case SENDER_IS_ACCEPTOR
:
1492 SIVAL(seq_num
, 4, 0x0);
1496 dump_data_pw("verf->seq_num:\n", seq_num
, sizeof(verf
->seq_num
));
1498 init_rpc_auth_netsec_chk(verf
, netsec_sig
, nullbytes
,
1499 seq_num
, confounder
);
1501 /* produce a digest of the packet to prove it's legit (before we seal it) */
1502 netsec_digest(a
, auth_flags
, verf
, data
, data_len
, digest_final
);
1503 memcpy(verf
->packet_digest
, digest_final
, sizeof(verf
->packet_digest
));
1505 if (auth_flags
& AUTH_PIPE_SEAL
) {
1506 uchar sealing_key
[16];
1508 /* get the key to encode the data with */
1509 netsec_get_sealing_key(a
, verf
, sealing_key
);
1511 /* encode the verification data */
1512 dump_data_pw("verf->confounder:\n", verf
->confounder
, sizeof(verf
->confounder
));
1513 SamOEMhash(verf
->confounder
, sealing_key
, 8);
1515 dump_data_pw("verf->confounder_enc:\n", verf
->confounder
, sizeof(verf
->confounder
));
1517 /* encode the packet payload */
1518 dump_data_pw("data:\n", (const unsigned char *)data
, data_len
);
1519 SamOEMhash((unsigned char *)data
, sealing_key
, data_len
);
1520 dump_data_pw("data_enc:\n", (const unsigned char *)data
, data_len
);
1523 /* encode the sequence number (key based on packet digest) */
1524 /* needs to be done after the sealing, as the original version
1525 is used in the sealing stuff... */
1526 netsec_deal_with_seq_num(a
, verf
);
1531 /*******************************************************************
1532 Decode a blob of data using the netsec (schannel) alogrithm, also verifiying
1533 a checksum over the original data. We currently can verify signed messages,
1534 as well as decode sealed messages
1535 ********************************************************************/
1537 BOOL
netsec_decode(struct netsec_auth_struct
*a
, int auth_flags
,
1538 enum netsec_direction direction
,
1539 RPC_AUTH_NETSEC_CHK
* verf
, char *data
, size_t data_len
)
1541 uchar digest_final
[16];
1543 static const uchar netsec_seal_sig
[8] = NETSEC_SEAL_SIGNATURE
;
1544 static const uchar netsec_sign_sig
[8] = NETSEC_SIGN_SIGNATURE
;
1545 const uchar
*netsec_sig
= NULL
;
1549 DEBUG(10,("SCHANNEL: netsec_encode seq_num=%d data_len=%lu\n", a
->seq_num
, (unsigned long)data_len
));
1551 if (auth_flags
& AUTH_PIPE_SEAL
) {
1552 netsec_sig
= netsec_seal_sig
;
1553 } else if (auth_flags
& AUTH_PIPE_SIGN
) {
1554 netsec_sig
= netsec_sign_sig
;
1557 /* Create the expected sequence number for comparison */
1558 RSIVAL(seq_num
, 0, a
->seq_num
);
1560 switch (direction
) {
1561 case SENDER_IS_INITIATOR
:
1562 SIVAL(seq_num
, 4, 0x80);
1564 case SENDER_IS_ACCEPTOR
:
1565 SIVAL(seq_num
, 4, 0x0);
1569 DEBUG(10,("SCHANNEL: netsec_decode seq_num=%d data_len=%lu\n", a
->seq_num
, (unsigned long)data_len
));
1570 dump_data_pw("a->sess_key:\n", a
->sess_key
, sizeof(a
->sess_key
));
1572 dump_data_pw("seq_num:\n", seq_num
, sizeof(seq_num
));
1574 /* extract the sequence number (key based on supplied packet digest) */
1575 /* needs to be done before the sealing, as the original version
1576 is used in the sealing stuff... */
1577 netsec_deal_with_seq_num(a
, verf
);
1579 if (memcmp(verf
->seq_num
, seq_num
, sizeof(seq_num
))) {
1580 /* don't even bother with the below if the sequence number is out */
1581 /* The sequence number is MD5'ed with a key based on the whole-packet
1582 digest, as supplied by the client. We check that it's a valid
1583 checksum after the decode, below
1585 DEBUG(2, ("netsec_decode: FAILED: packet sequence number:\n"));
1586 dump_data(2, (const char*)verf
->seq_num
, sizeof(verf
->seq_num
));
1587 DEBUG(2, ("should be:\n"));
1588 dump_data(2, (const char*)seq_num
, sizeof(seq_num
));
1593 if (memcmp(verf
->sig
, netsec_sig
, sizeof(verf
->sig
))) {
1594 /* Validate that the other end sent the expected header */
1595 DEBUG(2, ("netsec_decode: FAILED: packet header:\n"));
1596 dump_data(2, (const char*)verf
->sig
, sizeof(verf
->sig
));
1597 DEBUG(2, ("should be:\n"));
1598 dump_data(2, (const char*)netsec_sig
, sizeof(netsec_sig
));
1602 if (auth_flags
& AUTH_PIPE_SEAL
) {
1603 uchar sealing_key
[16];
1605 /* get the key to extract the data with */
1606 netsec_get_sealing_key(a
, verf
, sealing_key
);
1608 /* extract the verification data */
1609 dump_data_pw("verf->confounder:\n", verf
->confounder
,
1610 sizeof(verf
->confounder
));
1611 SamOEMhash(verf
->confounder
, sealing_key
, 8);
1613 dump_data_pw("verf->confounder_dec:\n", verf
->confounder
,
1614 sizeof(verf
->confounder
));
1616 /* extract the packet payload */
1617 dump_data_pw("data :\n", (const unsigned char *)data
, data_len
);
1618 SamOEMhash((unsigned char *)data
, sealing_key
, data_len
);
1619 dump_data_pw("datadec:\n", (const unsigned char *)data
, data_len
);
1622 /* digest includes 'data' after unsealing */
1623 netsec_digest(a
, auth_flags
, verf
, data
, data_len
, digest_final
);
1625 dump_data_pw("Calculated digest:\n", digest_final
,
1626 sizeof(digest_final
));
1627 dump_data_pw("verf->packet_digest:\n", verf
->packet_digest
,
1628 sizeof(verf
->packet_digest
));
1630 /* compare - if the client got the same result as us, then
1631 it must know the session key */
1632 return (memcmp(digest_final
, verf
->packet_digest
,
1633 sizeof(verf
->packet_digest
)) == 0);