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 *)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 char *prs_alloc_mem(prs_struct
*ps
, size_t size
)
151 ret
= talloc(ps
->mem_ctx
, size
);
153 memset(ret
, '\0', size
);
158 /*******************************************************************
159 Return the current talloc context we're using.
160 ********************************************************************/
162 TALLOC_CTX
*prs_get_mem_context(prs_struct
*ps
)
167 /*******************************************************************
168 Hand some already allocated memory to a prs_struct.
169 ********************************************************************/
171 void prs_give_memory(prs_struct
*ps
, char *buf
, uint32 size
, BOOL is_dynamic
)
173 ps
->is_dynamic
= is_dynamic
;
175 ps
->buffer_size
= size
;
178 /*******************************************************************
179 Take some memory back from a prs_struct.
180 ********************************************************************/
182 char *prs_take_memory(prs_struct
*ps
, uint32
*psize
)
184 char *ret
= ps
->data_p
;
186 *psize
= ps
->buffer_size
;
187 ps
->is_dynamic
= False
;
192 /*******************************************************************
193 Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
194 ********************************************************************/
196 BOOL
prs_set_buffer_size(prs_struct
*ps
, uint32 newsize
)
198 if (newsize
> ps
->buffer_size
)
199 return prs_force_grow(ps
, newsize
- ps
->buffer_size
);
201 if (newsize
< ps
->buffer_size
) {
202 char *new_data_p
= Realloc(ps
->data_p
, newsize
);
203 /* if newsize is zero, Realloc acts like free() & returns NULL*/
204 if (new_data_p
== NULL
&& newsize
!= 0) {
205 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
206 (unsigned int)newsize
));
207 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno
)));
210 ps
->data_p
= new_data_p
;
211 ps
->buffer_size
= newsize
;
217 /*******************************************************************
218 Attempt, if needed, to grow a data buffer.
219 Also depends on the data stream mode (io).
220 ********************************************************************/
222 BOOL
prs_grow(prs_struct
*ps
, uint32 extra_space
)
227 ps
->grow_size
= MAX(ps
->grow_size
, ps
->data_offset
+ extra_space
);
229 if(ps
->data_offset
+ extra_space
<= ps
->buffer_size
)
233 * We cannot grow the buffer if we're not reading
234 * into the prs_struct, or if we don't own the memory.
237 if(UNMARSHALLING(ps
) || !ps
->is_dynamic
) {
238 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
239 (unsigned int)extra_space
));
244 * Decide how much extra space we really need.
247 extra_space
-= (ps
->buffer_size
- ps
->data_offset
);
248 if(ps
->buffer_size
== 0) {
250 * Ensure we have at least a PDU's length, or extra_space, whichever
254 new_size
= MAX(MAX_PDU_FRAG_LEN
,extra_space
);
256 if((new_data
= malloc(new_size
)) == NULL
) {
257 DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size
));
260 memset(new_data
, '\0', (size_t)new_size
);
263 * If the current buffer size is bigger than the space needed, just
264 * double it, else add extra_space.
266 new_size
= MAX(ps
->buffer_size
*2, ps
->buffer_size
+ extra_space
);
268 if ((new_data
= Realloc(ps
->data_p
, new_size
)) == NULL
) {
269 DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
270 (unsigned int)new_size
));
274 memset(&new_data
[ps
->buffer_size
], '\0', (size_t)(new_size
- ps
->buffer_size
));
276 ps
->buffer_size
= new_size
;
277 ps
->data_p
= new_data
;
282 /*******************************************************************
283 Attempt to force a data buffer to grow by len bytes.
284 This is only used when appending more data onto a prs_struct
285 when reading an rpc reply, before unmarshalling it.
286 ********************************************************************/
288 BOOL
prs_force_grow(prs_struct
*ps
, uint32 extra_space
)
290 uint32 new_size
= ps
->buffer_size
+ extra_space
;
293 if(!UNMARSHALLING(ps
) || !ps
->is_dynamic
) {
294 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
295 (unsigned int)extra_space
));
299 if((new_data
= Realloc(ps
->data_p
, new_size
)) == NULL
) {
300 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
301 (unsigned int)new_size
));
305 memset(&new_data
[ps
->buffer_size
], '\0', (size_t)(new_size
- ps
->buffer_size
));
307 ps
->buffer_size
= new_size
;
308 ps
->data_p
= new_data
;
313 /*******************************************************************
314 Get the data pointer (external interface).
315 ********************************************************************/
317 char *prs_data_p(prs_struct
*ps
)
322 /*******************************************************************
323 Get the current data size (external interface).
324 ********************************************************************/
326 uint32
prs_data_size(prs_struct
*ps
)
328 return ps
->buffer_size
;
331 /*******************************************************************
332 Fetch the current offset (external interface).
333 ********************************************************************/
335 uint32
prs_offset(prs_struct
*ps
)
337 return ps
->data_offset
;
340 /*******************************************************************
341 Set the current offset (external interface).
342 ********************************************************************/
344 BOOL
prs_set_offset(prs_struct
*ps
, uint32 offset
)
346 if(offset
<= ps
->data_offset
) {
347 ps
->data_offset
= offset
;
351 if(!prs_grow(ps
, offset
- ps
->data_offset
))
354 ps
->data_offset
= offset
;
358 /*******************************************************************
359 Append the data from one parse_struct into another.
360 ********************************************************************/
362 BOOL
prs_append_prs_data(prs_struct
*dst
, prs_struct
*src
)
364 if (prs_offset(src
) == 0)
367 if(!prs_grow(dst
, prs_offset(src
)))
370 memcpy(&dst
->data_p
[dst
->data_offset
], src
->data_p
, (size_t)prs_offset(src
));
371 dst
->data_offset
+= prs_offset(src
);
376 /*******************************************************************
377 Append some data from one parse_struct into another.
378 ********************************************************************/
380 BOOL
prs_append_some_prs_data(prs_struct
*dst
, prs_struct
*src
, int32 start
, uint32 len
)
385 if(!prs_grow(dst
, len
))
388 memcpy(&dst
->data_p
[dst
->data_offset
], src
->data_p
+ start
, (size_t)len
);
389 dst
->data_offset
+= len
;
394 /*******************************************************************
395 Append the data from a buffer into a parse_struct.
396 ********************************************************************/
398 BOOL
prs_copy_data_in(prs_struct
*dst
, char *src
, uint32 len
)
403 if(!prs_grow(dst
, len
))
406 memcpy(&dst
->data_p
[dst
->data_offset
], src
, (size_t)len
);
407 dst
->data_offset
+= len
;
412 /*******************************************************************
413 Copy some data from a parse_struct into a buffer.
414 ********************************************************************/
416 BOOL
prs_copy_data_out(char *dst
, prs_struct
*src
, uint32 len
)
421 if(!prs_mem_get(src
, len
))
424 memcpy(dst
, &src
->data_p
[src
->data_offset
], (size_t)len
);
425 src
->data_offset
+= len
;
430 /*******************************************************************
431 Copy all the data from a parse_struct into a buffer.
432 ********************************************************************/
434 BOOL
prs_copy_all_data_out(char *dst
, prs_struct
*src
)
436 uint32 len
= prs_offset(src
);
441 prs_set_offset(src
, 0);
442 return prs_copy_data_out(dst
, src
, len
);
445 /*******************************************************************
446 Set the data as X-endian (external interface).
447 ********************************************************************/
449 void prs_set_endian_data(prs_struct
*ps
, BOOL endian
)
451 ps
->bigendian_data
= endian
;
454 /*******************************************************************
455 Align a the data_len to a multiple of align bytes - filling with
457 ********************************************************************/
459 BOOL
prs_align(prs_struct
*ps
)
461 uint32 mod
= ps
->data_offset
& (ps
->align
-1);
463 if (ps
->align
!= 0 && mod
!= 0) {
464 uint32 extra_space
= (ps
->align
- mod
);
465 if(!prs_grow(ps
, extra_space
))
467 memset(&ps
->data_p
[ps
->data_offset
], '\0', (size_t)extra_space
);
468 ps
->data_offset
+= extra_space
;
474 /******************************************************************
475 Align on a 2 byte boundary
476 *****************************************************************/
478 BOOL
prs_align_uint16(prs_struct
*ps
)
481 uint8 old_align
= ps
->align
;
485 ps
->align
= old_align
;
490 /******************************************************************
491 Align on a 8 byte boundary
492 *****************************************************************/
494 BOOL
prs_align_uint64(prs_struct
*ps
)
497 uint8 old_align
= ps
->align
;
501 ps
->align
= old_align
;
506 /*******************************************************************
507 Align only if required (for the unistr2 string mainly)
508 ********************************************************************/
510 BOOL
prs_align_needed(prs_struct
*ps
, uint32 needed
)
515 return prs_align(ps
);
518 /*******************************************************************
519 Ensure we can read/write to a given offset.
520 ********************************************************************/
522 char *prs_mem_get(prs_struct
*ps
, uint32 extra_size
)
524 if(UNMARSHALLING(ps
)) {
526 * If reading, ensure that we can read the requested size item.
528 if (ps
->data_offset
+ extra_size
> ps
->buffer_size
) {
529 DEBUG(0,("prs_mem_get: reading data of size %u would overrun buffer.\n",
530 (unsigned int)extra_size
));
535 * Writing - grow the buffer if needed.
537 if(!prs_grow(ps
, extra_size
))
540 return &ps
->data_p
[ps
->data_offset
];
543 /*******************************************************************
544 Change the struct type.
545 ********************************************************************/
547 void prs_switch_type(prs_struct
*ps
, BOOL io
)
549 if ((ps
->io
^ io
) == True
)
553 /*******************************************************************
554 Force a prs_struct to be dynamic even when it's size is 0.
555 ********************************************************************/
557 void prs_force_dynamic(prs_struct
*ps
)
562 /*******************************************************************
564 ********************************************************************/
566 BOOL
prs_uint8(const char *name
, prs_struct
*ps
, int depth
, uint8
*data8
)
568 char *q
= prs_mem_get(ps
, 1);
572 if (UNMARSHALLING(ps
))
577 DEBUG(5,("%s%04x %s: %02x\n", tab_depth(depth
), ps
->data_offset
, name
, *data8
));
579 ps
->data_offset
+= 1;
584 /*******************************************************************
586 ********************************************************************/
588 BOOL
prs_uint16(const char *name
, prs_struct
*ps
, int depth
, uint16
*data16
)
590 char *q
= prs_mem_get(ps
, sizeof(uint16
));
594 if (UNMARSHALLING(ps
)) {
595 if (ps
->bigendian_data
)
596 *data16
= RSVAL(q
,0);
600 if (ps
->bigendian_data
)
606 DEBUG(5,("%s%04x %s: %04x\n", tab_depth(depth
), ps
->data_offset
, name
, *data16
));
608 ps
->data_offset
+= sizeof(uint16
);
613 /*******************************************************************
615 ********************************************************************/
617 BOOL
prs_uint32(const char *name
, prs_struct
*ps
, int depth
, uint32
*data32
)
619 char *q
= prs_mem_get(ps
, sizeof(uint32
));
623 if (UNMARSHALLING(ps
)) {
624 if (ps
->bigendian_data
)
625 *data32
= RIVAL(q
,0);
629 if (ps
->bigendian_data
)
635 DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth
), ps
->data_offset
, name
, *data32
));
637 ps
->data_offset
+= sizeof(uint32
);
642 /*******************************************************************
644 ********************************************************************/
646 BOOL
prs_ntstatus(const char *name
, prs_struct
*ps
, int depth
, NTSTATUS
*status
)
648 char *q
= prs_mem_get(ps
, sizeof(uint32
));
652 if (UNMARSHALLING(ps
)) {
653 if (ps
->bigendian_data
)
654 *status
= NT_STATUS(RIVAL(q
,0));
656 *status
= NT_STATUS(IVAL(q
,0));
658 if (ps
->bigendian_data
)
659 RSIVAL(q
,0,NT_STATUS_V(*status
));
661 SIVAL(q
,0,NT_STATUS_V(*status
));
664 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth
), ps
->data_offset
, name
,
665 nt_errstr(*status
)));
667 ps
->data_offset
+= sizeof(uint32
);
672 /*******************************************************************
674 ********************************************************************/
676 BOOL
prs_werror(const char *name
, prs_struct
*ps
, int depth
, WERROR
*status
)
678 char *q
= prs_mem_get(ps
, sizeof(uint32
));
682 if (UNMARSHALLING(ps
)) {
683 if (ps
->bigendian_data
)
684 *status
= W_ERROR(RIVAL(q
,0));
686 *status
= W_ERROR(IVAL(q
,0));
688 if (ps
->bigendian_data
)
689 RSIVAL(q
,0,W_ERROR_V(*status
));
691 SIVAL(q
,0,W_ERROR_V(*status
));
694 DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth
), ps
->data_offset
, name
,
695 dos_errstr(*status
)));
697 ps
->data_offset
+= sizeof(uint32
);
703 /******************************************************************
704 Stream an array of uint8s. Length is number of uint8s.
705 ********************************************************************/
707 BOOL
prs_uint8s(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint8
*data8s
, int len
)
710 char *q
= prs_mem_get(ps
, len
);
714 if (UNMARSHALLING(ps
)) {
715 for (i
= 0; i
< len
; i
++)
716 data8s
[i
] = CVAL(q
,i
);
718 for (i
= 0; i
< len
; i
++)
719 SCVAL(q
, i
, data8s
[i
]);
722 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
,name
));
724 print_asc(5, (unsigned char*)data8s
, len
);
726 for (i
= 0; i
< len
; i
++)
727 DEBUG(5,("%02x ", data8s
[i
]));
731 ps
->data_offset
+= len
;
736 /******************************************************************
737 Stream an array of uint16s. Length is number of uint16s.
738 ********************************************************************/
740 BOOL
prs_uint16s(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint16
*data16s
, int len
)
743 char *q
= prs_mem_get(ps
, len
* sizeof(uint16
));
747 if (UNMARSHALLING(ps
)) {
748 if (ps
->bigendian_data
) {
749 for (i
= 0; i
< len
; i
++)
750 data16s
[i
] = RSVAL(q
, 2*i
);
752 for (i
= 0; i
< len
; i
++)
753 data16s
[i
] = SVAL(q
, 2*i
);
756 if (ps
->bigendian_data
) {
757 for (i
= 0; i
< len
; i
++)
758 RSSVAL(q
, 2*i
, data16s
[i
]);
760 for (i
= 0; i
< len
; i
++)
761 SSVAL(q
, 2*i
, data16s
[i
]);
765 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
767 print_asc(5, (unsigned char*)data16s
, 2*len
);
769 for (i
= 0; i
< len
; i
++)
770 DEBUG(5,("%04x ", data16s
[i
]));
774 ps
->data_offset
+= (len
* sizeof(uint16
));
779 /******************************************************************
780 Start using a function for streaming unicode chars. If unmarshalling,
781 output must be little-endian, if marshalling, input must be little-endian.
782 ********************************************************************/
784 static void dbg_rw_punival(BOOL charmode
, const char *name
, int depth
, prs_struct
*ps
,
785 char *in_buf
, char *out_buf
, int len
)
789 if (UNMARSHALLING(ps
)) {
790 if (ps
->bigendian_data
) {
791 for (i
= 0; i
< len
; i
++)
792 SSVAL(out_buf
,2*i
,RSVAL(in_buf
, 2*i
));
794 for (i
= 0; i
< len
; i
++)
795 SSVAL(out_buf
, 2*i
, SVAL(in_buf
, 2*i
));
798 if (ps
->bigendian_data
) {
799 for (i
= 0; i
< len
; i
++)
800 RSSVAL(in_buf
, 2*i
, SVAL(out_buf
,2*i
));
802 for (i
= 0; i
< len
; i
++)
803 SSVAL(in_buf
, 2*i
, SVAL(out_buf
,2*i
));
807 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
809 print_asc(5, (unsigned char*)out_buf
, 2*len
);
811 for (i
= 0; i
< len
; i
++)
812 DEBUG(5,("%04x ", out_buf
[i
]));
817 /******************************************************************
818 Stream a unistr. Always little endian.
819 ********************************************************************/
821 BOOL
prs_uint16uni(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint16
*data16s
, int len
)
823 char *q
= prs_mem_get(ps
, len
* sizeof(uint16
));
827 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, (char *)data16s
, len
);
828 ps
->data_offset
+= (len
* sizeof(uint16
));
833 /******************************************************************
834 Stream an array of uint32s. Length is number of uint32s.
835 ********************************************************************/
837 BOOL
prs_uint32s(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, uint32
*data32s
, int len
)
840 char *q
= prs_mem_get(ps
, len
* sizeof(uint32
));
844 if (UNMARSHALLING(ps
)) {
845 if (ps
->bigendian_data
) {
846 for (i
= 0; i
< len
; i
++)
847 data32s
[i
] = RIVAL(q
, 4*i
);
849 for (i
= 0; i
< len
; i
++)
850 data32s
[i
] = IVAL(q
, 4*i
);
853 if (ps
->bigendian_data
) {
854 for (i
= 0; i
< len
; i
++)
855 RSIVAL(q
, 4*i
, data32s
[i
]);
857 for (i
= 0; i
< len
; i
++)
858 SIVAL(q
, 4*i
, data32s
[i
]);
862 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
864 print_asc(5, (unsigned char*)data32s
, 4*len
);
866 for (i
= 0; i
< len
; i
++)
867 DEBUG(5,("%08x ", data32s
[i
]));
871 ps
->data_offset
+= (len
* sizeof(uint32
));
876 /******************************************************************
877 Stream an array of unicode string, length/buffer specified separately,
878 in uint16 chars. The unicode string is already in little-endian format.
879 ********************************************************************/
881 BOOL
prs_buffer5(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, BUFFER5
*str
)
884 char *q
= prs_mem_get(ps
, str
->buf_len
* sizeof(uint16
));
888 if (UNMARSHALLING(ps
)) {
889 str
->buffer
= (uint16
*)prs_alloc_mem(ps
,str
->buf_len
* sizeof(uint16
));
890 if (str
->buffer
== NULL
)
894 /* If the string is empty, we don't have anything to stream */
898 p
= (char *)str
->buffer
;
900 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->buf_len
);
902 ps
->data_offset
+= (str
->buf_len
* sizeof(uint16
));
907 /******************************************************************
908 Stream a "not" unicode string, length/buffer specified separately,
909 in byte chars. String is in little-endian format.
910 ********************************************************************/
912 BOOL
prs_buffer2(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, BUFFER2
*str
)
915 char *q
= prs_mem_get(ps
, str
->buf_len
);
919 if (UNMARSHALLING(ps
)) {
920 if ( str
->buf_len
) {
921 str
->buffer
= (uint16
*)prs_alloc_mem(ps
,str
->buf_len
);
922 if ( str
->buffer
== NULL
)
927 p
= (char *)str
->buffer
;
929 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->buf_len
/2);
930 ps
->data_offset
+= str
->buf_len
;
935 /******************************************************************
936 Stream a string, length/buffer specified separately,
938 ********************************************************************/
940 BOOL
prs_string2(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, STRING2
*str
)
943 char *q
= prs_mem_get(ps
, str
->str_max_len
);
947 if (UNMARSHALLING(ps
)) {
948 str
->buffer
= (unsigned char *)prs_alloc_mem(ps
,str
->str_max_len
);
949 if (str
->buffer
== NULL
)
953 if (UNMARSHALLING(ps
)) {
954 for (i
= 0; i
< str
->str_str_len
; i
++)
955 str
->buffer
[i
] = CVAL(q
,i
);
957 for (i
= 0; i
< str
->str_str_len
; i
++)
958 SCVAL(q
, i
, str
->buffer
[i
]);
961 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
963 print_asc(5, (unsigned char*)str
->buffer
, str
->str_str_len
);
965 for (i
= 0; i
< str
->str_str_len
; i
++)
966 DEBUG(5,("%02x ", str
->buffer
[i
]));
970 ps
->data_offset
+= str
->str_str_len
;
975 /******************************************************************
976 Stream a unicode string, length/buffer specified separately,
977 in uint16 chars. The unicode string is already in little-endian format.
978 ********************************************************************/
980 BOOL
prs_unistr2(BOOL charmode
, const char *name
, prs_struct
*ps
, int depth
, UNISTR2
*str
)
983 char *q
= prs_mem_get(ps
, str
->uni_str_len
* sizeof(uint16
));
987 /* If the string is empty, we don't have anything to stream */
988 if (str
->uni_str_len
==0)
991 if (UNMARSHALLING(ps
)) {
992 str
->buffer
= (uint16
*)prs_alloc_mem(ps
,str
->uni_max_len
* sizeof(uint16
));
993 if (str
->buffer
== NULL
)
997 p
= (char *)str
->buffer
;
999 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->uni_str_len
);
1001 ps
->data_offset
+= (str
->uni_str_len
* sizeof(uint16
));
1006 /******************************************************************
1007 Stream a unicode string, length/buffer specified separately,
1008 in uint16 chars. The unicode string is already in little-endian format.
1009 ********************************************************************/
1011 BOOL
prs_unistr3(BOOL charmode
, const char *name
, UNISTR3
*str
, prs_struct
*ps
, int depth
)
1014 char *q
= prs_mem_get(ps
, str
->uni_str_len
* sizeof(uint16
));
1018 if (UNMARSHALLING(ps
)) {
1019 str
->str
.buffer
= (uint16
*)prs_alloc_mem(ps
,str
->uni_str_len
* sizeof(uint16
));
1020 if (str
->str
.buffer
== NULL
)
1024 p
= (char *)str
->str
.buffer
;
1026 dbg_rw_punival(charmode
, name
, depth
, ps
, q
, p
, str
->uni_str_len
);
1027 ps
->data_offset
+= (str
->uni_str_len
* sizeof(uint16
));
1032 /*******************************************************************
1033 Stream a unicode null-terminated string. As the string is already
1034 in little-endian format then do it as a stream of bytes.
1035 ********************************************************************/
1037 BOOL
prs_unistr(const char *name
, prs_struct
*ps
, int depth
, UNISTR
*str
)
1039 unsigned int len
= 0;
1040 unsigned char *p
= (unsigned char *)str
->buffer
;
1046 if (MARSHALLING(ps
)) {
1048 for(len
= 0; str
->buffer
[len
] != 0; len
++)
1051 q
= prs_mem_get(ps
, (len
+1)*2);
1057 for(len
= 0; str
->buffer
[len
] != 0; len
++)
1059 if(ps
->bigendian_data
)
1061 /* swap bytes - p is little endian, q is big endian. */
1077 * even if the string is 'empty' (only an \0 char)
1078 * at this point the leading \0 hasn't been parsed.
1088 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
1089 print_asc(5, (unsigned char*)start
, 2*len
);
1092 else { /* unmarshalling */
1094 uint32 alloc_len
= 0;
1095 q
= ps
->data_p
+ prs_offset(ps
);
1098 * Work out how much space we need and talloc it.
1100 max_len
= (ps
->buffer_size
- ps
->data_offset
)/sizeof(uint16
);
1102 /* the test of the value of *ptr helps to catch the circumstance
1103 where we have an emtpty (non-existent) string in the buffer */
1104 for ( ptr
= (uint16
*)q
; *ptr
++ && (alloc_len
<= max_len
); alloc_len
++)
1108 if (alloc_len
< max_len
)
1111 /* should we allocate anything at all? */
1112 str
->buffer
= (uint16
*)prs_alloc_mem(ps
,alloc_len
* sizeof(uint16
));
1113 if ((str
->buffer
== NULL
) && (alloc_len
> 0))
1116 p
= (unsigned char *)str
->buffer
;
1119 /* the (len < alloc_len) test is to prevent us from overwriting
1120 memory that is not ours...if we get that far, we have a non-null
1121 terminated string in the buffer and have messed up somewhere */
1122 while ((len
< alloc_len
) && (*(uint16
*)q
!= 0))
1124 if(ps
->bigendian_data
)
1126 /* swap bytes - q is big endian, p is little endian. */
1127 p
[0] = (unsigned char)q
[1];
1128 p
[1] = (unsigned char)q
[0];
1133 p
[0] = (unsigned char)q
[0];
1134 p
[1] = (unsigned char)q
[1];
1141 if (len
< alloc_len
)
1143 /* NULL terminate the UNISTR */
1144 str
->buffer
[len
++] = '\0';
1147 DEBUG(5,("%s%04x %s: ", tab_depth(depth
), ps
->data_offset
, name
));
1148 print_asc(5, (unsigned char*)str
->buffer
, 2*len
);
1152 /* set the offset in the prs_struct; 'len' points to the
1153 terminiating NULL in the UNISTR so we need to go one more
1155 ps
->data_offset
+= (len
)*2;
1161 /*******************************************************************
1162 Stream a null-terminated string. len is strlen, and therefore does
1163 not include the null-termination character.
1164 ********************************************************************/
1166 BOOL
prs_string(const char *name
, prs_struct
*ps
, int depth
, char *str
, int max_buf_size
)
1172 if (UNMARSHALLING(ps
))
1173 len
= strlen(&ps
->data_p
[ps
->data_offset
]);
1177 len
= MIN(len
, (max_buf_size
-1));
1179 q
= prs_mem_get(ps
, len
+1);
1183 for(i
= 0; i
< len
; i
++) {
1184 if (UNMARSHALLING(ps
))
1190 /* The terminating null. */
1193 if (MARSHALLING(ps
)) {
1197 ps
->data_offset
+= len
+1;
1199 dump_data(5+depth
, q
, len
);
1204 /*******************************************************************
1205 prs_uint16 wrapper. Call this and it sets up a pointer to where the
1206 uint16 should be stored, or gets the size if reading.
1207 ********************************************************************/
1209 BOOL
prs_uint16_pre(const char *name
, prs_struct
*ps
, int depth
, uint16
*data16
, uint32
*offset
)
1211 *offset
= ps
->data_offset
;
1212 if (UNMARSHALLING(ps
)) {
1214 return prs_uint16(name
, ps
, depth
, data16
);
1216 char *q
= prs_mem_get(ps
, sizeof(uint16
));
1219 ps
->data_offset
+= sizeof(uint16
);
1224 /*******************************************************************
1225 prs_uint16 wrapper. call this and it retrospectively stores the size.
1226 does nothing on reading, as that is already handled by ...._pre()
1227 ********************************************************************/
1229 BOOL
prs_uint16_post(const char *name
, prs_struct
*ps
, int depth
, uint16
*data16
,
1230 uint32 ptr_uint16
, uint32 start_offset
)
1232 if (MARSHALLING(ps
)) {
1234 * Writing - temporarily move the offset pointer.
1236 uint16 data_size
= ps
->data_offset
- start_offset
;
1237 uint32 old_offset
= ps
->data_offset
;
1239 ps
->data_offset
= ptr_uint16
;
1240 if(!prs_uint16(name
, ps
, depth
, &data_size
)) {
1241 ps
->data_offset
= old_offset
;
1244 ps
->data_offset
= old_offset
;
1246 ps
->data_offset
= start_offset
+ (uint32
)(*data16
);
1251 /*******************************************************************
1252 prs_uint32 wrapper. Call this and it sets up a pointer to where the
1253 uint32 should be stored, or gets the size if reading.
1254 ********************************************************************/
1256 BOOL
prs_uint32_pre(const char *name
, prs_struct
*ps
, int depth
, uint32
*data32
, uint32
*offset
)
1258 *offset
= ps
->data_offset
;
1259 if (UNMARSHALLING(ps
) && (data32
!= NULL
)) {
1261 return prs_uint32(name
, ps
, depth
, data32
);
1263 ps
->data_offset
+= sizeof(uint32
);
1268 /*******************************************************************
1269 prs_uint32 wrapper. call this and it retrospectively stores the size.
1270 does nothing on reading, as that is already handled by ...._pre()
1271 ********************************************************************/
1273 BOOL
prs_uint32_post(const char *name
, prs_struct
*ps
, int depth
, uint32
*data32
,
1274 uint32 ptr_uint32
, uint32 data_size
)
1276 if (MARSHALLING(ps
)) {
1278 * Writing - temporarily move the offset pointer.
1280 uint32 old_offset
= ps
->data_offset
;
1281 ps
->data_offset
= ptr_uint32
;
1282 if(!prs_uint32(name
, ps
, depth
, &data_size
)) {
1283 ps
->data_offset
= old_offset
;
1286 ps
->data_offset
= old_offset
;
1291 /* useful function to store a structure in rpc wire format */
1292 int tdb_prs_store(TDB_CONTEXT
*tdb
, char *keystr
, prs_struct
*ps
)
1294 TDB_DATA kbuf
, dbuf
;
1296 kbuf
.dsize
= strlen(keystr
)+1;
1297 dbuf
.dptr
= ps
->data_p
;
1298 dbuf
.dsize
= prs_offset(ps
);
1299 return tdb_store(tdb
, kbuf
, dbuf
, TDB_REPLACE
);
1302 /* useful function to fetch a structure into rpc wire format */
1303 int tdb_prs_fetch(TDB_CONTEXT
*tdb
, char *keystr
, prs_struct
*ps
, TALLOC_CTX
*mem_ctx
)
1305 TDB_DATA kbuf
, dbuf
;
1307 kbuf
.dsize
= strlen(keystr
)+1;
1309 dbuf
= tdb_fetch(tdb
, kbuf
);
1313 prs_init(ps
, 0, mem_ctx
, UNMARSHALL
);
1314 prs_give_memory(ps
, dbuf
.dptr
, dbuf
.dsize
, True
);
1319 /*******************************************************************
1321 ********************************************************************/
1322 BOOL
prs_hash1(prs_struct
*ps
, uint32 offset
, uint8 sess_key
[16], int len
)
1329 #ifdef DEBUG_PASSWORD
1330 DEBUG(100, ("prs_hash1\n"));
1331 dump_data(100, sess_key
, 16);
1332 dump_data(100, q
, len
);
1334 SamOEMhash((uchar
*) q
, sess_key
, len
);
1336 #ifdef DEBUG_PASSWORD
1337 dump_data(100, q
, len
);
1344 /*******************************************************************
1345 Create a digest over the entire packet (including the data), and
1346 MD5 it with the session key.
1347 ********************************************************************/
1348 static void netsec_digest(struct netsec_auth_struct
*a
,
1350 RPC_AUTH_NETSEC_CHK
* verf
,
1351 char *data
, size_t data_len
,
1352 uchar digest_final
[16])
1354 uchar whole_packet_digest
[16];
1355 static uchar zeros
[4];
1356 struct MD5Context ctx3
;
1358 /* verfiy the signature on the packet by MD5 over various bits */
1360 /* use our sequence number, which ensures the packet is not
1362 MD5Update(&ctx3
, zeros
, sizeof(zeros
));
1363 MD5Update(&ctx3
, verf
->sig
, sizeof(verf
->sig
));
1364 if (auth_flags
& AUTH_PIPE_SEAL
) {
1365 MD5Update(&ctx3
, verf
->confounder
, sizeof(verf
->confounder
));
1367 MD5Update(&ctx3
, (const unsigned char *)data
, data_len
);
1368 MD5Final(whole_packet_digest
, &ctx3
);
1369 dump_data_pw("whole_packet_digest:\n", whole_packet_digest
, sizeof(whole_packet_digest
));
1371 /* MD5 this result and the session key, to prove that
1372 only a valid client could had produced this */
1373 hmac_md5(a
->sess_key
, whole_packet_digest
, sizeof(whole_packet_digest
), digest_final
);
1376 /*******************************************************************
1377 Calculate the key with which to encode the data payload
1378 ********************************************************************/
1379 static void netsec_get_sealing_key(struct netsec_auth_struct
*a
,
1380 RPC_AUTH_NETSEC_CHK
*verf
,
1381 uchar sealing_key
[16])
1383 static uchar zeros
[4];
1388 for (i
= 0; i
< sizeof(sess_kf0
); i
++) {
1389 sess_kf0
[i
] = a
->sess_key
[i
] ^ 0xf0;
1392 dump_data_pw("sess_kf0:\n", sess_kf0
, sizeof(sess_kf0
));
1394 /* MD5 of sess_kf0 and 4 zero bytes */
1395 hmac_md5(sess_kf0
, zeros
, 0x4, digest2
);
1396 dump_data_pw("digest2:\n", digest2
, sizeof(digest2
));
1398 /* MD5 of the above result, plus 8 bytes of sequence number */
1399 hmac_md5(digest2
, verf
->seq_num
, sizeof(verf
->seq_num
), sealing_key
);
1400 dump_data_pw("sealing_key:\n", sealing_key
, 16);
1403 /*******************************************************************
1404 Encode or Decode the sequence number (which is symmetric)
1405 ********************************************************************/
1406 static void netsec_deal_with_seq_num(struct netsec_auth_struct
*a
,
1407 RPC_AUTH_NETSEC_CHK
*verf
)
1409 static uchar zeros
[4];
1410 uchar sequence_key
[16];
1413 hmac_md5(a
->sess_key
, zeros
, sizeof(zeros
), digest1
);
1414 dump_data_pw("(sequence key) digest1:\n", digest1
, sizeof(digest1
));
1416 hmac_md5(digest1
, verf
->packet_digest
, 8, sequence_key
);
1418 dump_data_pw("sequence_key:\n", sequence_key
, sizeof(sequence_key
));
1420 dump_data_pw("seq_num (before):\n", verf
->seq_num
, sizeof(verf
->seq_num
));
1421 SamOEMhash(verf
->seq_num
, sequence_key
, 8);
1422 dump_data_pw("seq_num (after):\n", verf
->seq_num
, sizeof(verf
->seq_num
));
1425 /*******************************************************************
1426 creates an RPC_AUTH_NETSEC_CHK structure.
1427 ********************************************************************/
1428 static BOOL
init_rpc_auth_netsec_chk(RPC_AUTH_NETSEC_CHK
* chk
,
1430 const uchar packet_digest
[8],
1431 const uchar seq_num
[8], const uchar confounder
[8])
1436 memcpy(chk
->sig
, sig
, sizeof(chk
->sig
));
1437 memcpy(chk
->packet_digest
, packet_digest
, sizeof(chk
->packet_digest
));
1438 memcpy(chk
->seq_num
, seq_num
, sizeof(chk
->seq_num
));
1439 memcpy(chk
->confounder
, confounder
, sizeof(chk
->confounder
));
1445 /*******************************************************************
1446 Encode a blob of data using the netsec (schannel) alogrithm, also produceing
1447 a checksum over the original data. We currently only support
1448 signing and sealing togeather - the signing-only code is close, but not
1449 quite compatible with what MS does.
1450 ********************************************************************/
1451 void netsec_encode(struct netsec_auth_struct
*a
, int auth_flags
,
1452 enum netsec_direction direction
,
1453 RPC_AUTH_NETSEC_CHK
* verf
,
1454 char *data
, size_t data_len
)
1456 uchar digest_final
[16];
1457 uchar confounder
[8];
1459 static const uchar nullbytes
[8];
1461 static const uchar netsec_seal_sig
[8] = NETSEC_SEAL_SIGNATURE
;
1462 static const uchar netsec_sign_sig
[8] = NETSEC_SIGN_SIGNATURE
;
1463 const uchar
*netsec_sig
= NULL
;
1465 DEBUG(10,("SCHANNEL: netsec_encode seq_num=%d data_len=%lu\n", a
->seq_num
, (unsigned long)data_len
));
1467 if (auth_flags
& AUTH_PIPE_SEAL
) {
1468 netsec_sig
= netsec_seal_sig
;
1469 } else if (auth_flags
& AUTH_PIPE_SIGN
) {
1470 netsec_sig
= netsec_sign_sig
;
1473 /* fill the 'confounder' with random data */
1474 generate_random_buffer(confounder
, sizeof(confounder
));
1476 dump_data_pw("a->sess_key:\n", a
->sess_key
, sizeof(a
->sess_key
));
1478 RSIVAL(seq_num
, 0, a
->seq_num
);
1480 switch (direction
) {
1481 case SENDER_IS_INITIATOR
:
1482 SIVAL(seq_num
, 4, 0x80);
1484 case SENDER_IS_ACCEPTOR
:
1485 SIVAL(seq_num
, 4, 0x0);
1489 dump_data_pw("verf->seq_num:\n", seq_num
, sizeof(verf
->seq_num
));
1491 init_rpc_auth_netsec_chk(verf
, netsec_sig
, nullbytes
,
1492 seq_num
, confounder
);
1494 /* produce a digest of the packet to prove it's legit (before we seal it) */
1495 netsec_digest(a
, auth_flags
, verf
, data
, data_len
, digest_final
);
1496 memcpy(verf
->packet_digest
, digest_final
, sizeof(verf
->packet_digest
));
1498 if (auth_flags
& AUTH_PIPE_SEAL
) {
1499 uchar sealing_key
[16];
1501 /* get the key to encode the data with */
1502 netsec_get_sealing_key(a
, verf
, sealing_key
);
1504 /* encode the verification data */
1505 dump_data_pw("verf->confounder:\n", verf
->confounder
, sizeof(verf
->confounder
));
1506 SamOEMhash(verf
->confounder
, sealing_key
, 8);
1508 dump_data_pw("verf->confounder_enc:\n", verf
->confounder
, sizeof(verf
->confounder
));
1510 /* encode the packet payload */
1511 dump_data_pw("data:\n", (const unsigned char *)data
, data_len
);
1512 SamOEMhash((unsigned char *)data
, sealing_key
, data_len
);
1513 dump_data_pw("data_enc:\n", (const unsigned char *)data
, data_len
);
1516 /* encode the sequence number (key based on packet digest) */
1517 /* needs to be done after the sealing, as the original version
1518 is used in the sealing stuff... */
1519 netsec_deal_with_seq_num(a
, verf
);
1524 /*******************************************************************
1525 Decode a blob of data using the netsec (schannel) alogrithm, also verifiying
1526 a checksum over the original data. We currently can verify signed messages,
1527 as well as decode sealed messages
1528 ********************************************************************/
1530 BOOL
netsec_decode(struct netsec_auth_struct
*a
, int auth_flags
,
1531 enum netsec_direction direction
,
1532 RPC_AUTH_NETSEC_CHK
* verf
, char *data
, size_t data_len
)
1534 uchar digest_final
[16];
1536 static const uchar netsec_seal_sig
[8] = NETSEC_SEAL_SIGNATURE
;
1537 static const uchar netsec_sign_sig
[8] = NETSEC_SIGN_SIGNATURE
;
1538 const uchar
*netsec_sig
= NULL
;
1542 DEBUG(10,("SCHANNEL: netsec_encode seq_num=%d data_len=%lu\n", a
->seq_num
, (unsigned long)data_len
));
1544 if (auth_flags
& AUTH_PIPE_SEAL
) {
1545 netsec_sig
= netsec_seal_sig
;
1546 } else if (auth_flags
& AUTH_PIPE_SIGN
) {
1547 netsec_sig
= netsec_sign_sig
;
1550 /* Create the expected sequence number for comparison */
1551 RSIVAL(seq_num
, 0, a
->seq_num
);
1553 switch (direction
) {
1554 case SENDER_IS_INITIATOR
:
1555 SIVAL(seq_num
, 4, 0x80);
1557 case SENDER_IS_ACCEPTOR
:
1558 SIVAL(seq_num
, 4, 0x0);
1562 DEBUG(10,("SCHANNEL: netsec_decode seq_num=%d data_len=%lu\n", a
->seq_num
, (unsigned long)data_len
));
1563 dump_data_pw("a->sess_key:\n", a
->sess_key
, sizeof(a
->sess_key
));
1565 dump_data_pw("seq_num:\n", seq_num
, sizeof(seq_num
));
1567 /* extract the sequence number (key based on supplied packet digest) */
1568 /* needs to be done before the sealing, as the original version
1569 is used in the sealing stuff... */
1570 netsec_deal_with_seq_num(a
, verf
);
1572 if (memcmp(verf
->seq_num
, seq_num
, sizeof(seq_num
))) {
1573 /* don't even bother with the below if the sequence number is out */
1574 /* The sequence number is MD5'ed with a key based on the whole-packet
1575 digest, as supplied by the client. We check that it's a valid
1576 checksum after the decode, below
1578 DEBUG(2, ("netsec_decode: FAILED: packet sequence number:\n"));
1579 dump_data(2, (const char*)verf
->seq_num
, sizeof(verf
->seq_num
));
1580 DEBUG(2, ("should be:\n"));
1581 dump_data(2, (const char*)seq_num
, sizeof(seq_num
));
1586 if (memcmp(verf
->sig
, netsec_sig
, sizeof(verf
->sig
))) {
1587 /* Validate that the other end sent the expected header */
1588 DEBUG(2, ("netsec_decode: FAILED: packet header:\n"));
1589 dump_data(2, (const char*)verf
->sig
, sizeof(verf
->sig
));
1590 DEBUG(2, ("should be:\n"));
1591 dump_data(2, (const char*)netsec_sig
, sizeof(netsec_sig
));
1595 if (auth_flags
& AUTH_PIPE_SEAL
) {
1596 uchar sealing_key
[16];
1598 /* get the key to extract the data with */
1599 netsec_get_sealing_key(a
, verf
, sealing_key
);
1601 /* extract the verification data */
1602 dump_data_pw("verf->confounder:\n", verf
->confounder
,
1603 sizeof(verf
->confounder
));
1604 SamOEMhash(verf
->confounder
, sealing_key
, 8);
1606 dump_data_pw("verf->confounder_dec:\n", verf
->confounder
,
1607 sizeof(verf
->confounder
));
1609 /* extract the packet payload */
1610 dump_data_pw("data :\n", (const unsigned char *)data
, data_len
);
1611 SamOEMhash((unsigned char *)data
, sealing_key
, data_len
);
1612 dump_data_pw("datadec:\n", (const unsigned char *)data
, data_len
);
1615 /* digest includes 'data' after unsealing */
1616 netsec_digest(a
, auth_flags
, verf
, data
, data_len
, digest_final
);
1618 dump_data_pw("Calculated digest:\n", digest_final
,
1619 sizeof(digest_final
));
1620 dump_data_pw("verf->packet_digest:\n", verf
->packet_digest
,
1621 sizeof(verf
->packet_digest
));
1623 /* compare - if the client got the same result as us, then
1624 it must know the session key */
1625 return (memcmp(digest_final
, verf
->packet_digest
,
1626 sizeof(verf
->packet_digest
)) == 0);