r23080: Fix bug #4637 - we hads missed some cases where
[samba.git] / source / rpc_parse / parse_prs.c
1 /* 
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.
8    
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.
13    
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.
18    
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.
22 */
23
24 #include "includes.h"
25
26 #undef DBGC_CLASS
27 #define DBGC_CLASS DBGC_RPC_PARSE
28
29 /**
30  * Dump a prs to a file: from the current location through to the end.
31  **/
32 void prs_dump(char *name, int v, prs_struct *ps)
33 {
34         prs_dump_region(name, v, ps, ps->data_offset, ps->buffer_size);
35 }
36
37 /**
38  * Dump from the start of the prs to the current location.
39  **/
40 void prs_dump_before(char *name, int v, prs_struct *ps)
41 {
42         prs_dump_region(name, v, ps, 0, ps->data_offset);
43 }
44
45 /**
46  * Dump everything from the start of the prs up to the current location.
47  **/
48 void prs_dump_region(char *name, int v, prs_struct *ps,
49                      int from_off, int to_off)
50 {
51         int fd, i;
52         pstring fname;
53         ssize_t sz;
54         if (DEBUGLEVEL < 50) return;
55         for (i=1;i<100;i++) {
56                 if (v != -1) {
57                         slprintf(fname,sizeof(fname)-1, "/tmp/%s_%d.%d.prs", name, v, i);
58                 } else {
59                         slprintf(fname,sizeof(fname)-1, "/tmp/%s.%d.prs", name, i);
60                 }
61                 fd = open(fname, O_WRONLY|O_CREAT|O_EXCL, 0644);
62                 if (fd != -1 || errno != EEXIST) break;
63         }
64         if (fd != -1) {
65                 sz = write(fd, ps->data_p + from_off, to_off - from_off);
66                 i = close(fd);
67                 if ( (sz != to_off-from_off) || (i != 0) ) {
68                         DEBUG(0,("Error writing/closing %s: %ld!=%ld %d\n", fname, (unsigned long)sz, (unsigned long)to_off-from_off, i ));
69                 } else {
70                         DEBUG(0,("created %s\n", fname));
71                 }
72         }
73 }
74
75 /*******************************************************************
76  Debug output for parsing info
77
78  XXXX side-effect of this function is to increase the debug depth XXXX.
79
80 ********************************************************************/
81
82 void prs_debug(prs_struct *ps, int depth, const char *desc, const char *fn_name)
83 {
84         DEBUG(5+depth, ("%s%06x %s %s\n", tab_depth(depth), ps->data_offset, fn_name, desc));
85 }
86
87 /**
88  * Initialise an expandable parse structure.
89  *
90  * @param size Initial buffer size.  If >0, a new buffer will be
91  * created with malloc().
92  *
93  * @return False if allocation fails, otherwise True.
94  **/
95
96 BOOL prs_init(prs_struct *ps, uint32 size, TALLOC_CTX *ctx, BOOL io)
97 {
98         ZERO_STRUCTP(ps);
99         ps->io = io;
100         ps->bigendian_data = RPC_LITTLE_ENDIAN;
101         ps->align = RPC_PARSE_ALIGN;
102         ps->is_dynamic = False;
103         ps->data_offset = 0;
104         ps->buffer_size = 0;
105         ps->data_p = NULL;
106         ps->mem_ctx = ctx;
107
108         if (size != 0) {
109                 ps->buffer_size = size;
110                 if((ps->data_p = (char *)SMB_MALLOC((size_t)size)) == NULL) {
111                         DEBUG(0,("prs_init: malloc fail for %u bytes.\n", (unsigned int)size));
112                         return False;
113                 }
114                 memset(ps->data_p, '\0', (size_t)size);
115                 ps->is_dynamic = True; /* We own this memory. */
116         } else if (MARSHALLING(ps)) {
117                 /* If size is zero and we're marshalling we should allocate memory on demand. */
118                 ps->is_dynamic = True;
119         }
120
121         return True;
122 }
123
124 /*******************************************************************
125  Delete the memory in a parse structure - if we own it.
126  ********************************************************************/
127
128 void prs_mem_free(prs_struct *ps)
129 {
130         if(ps->is_dynamic)
131                 SAFE_FREE(ps->data_p);
132         ps->is_dynamic = False;
133         ps->buffer_size = 0;
134         ps->data_offset = 0;
135 }
136
137 /*******************************************************************
138  Clear the memory in a parse structure.
139  ********************************************************************/
140
141 void prs_mem_clear(prs_struct *ps)
142 {
143         if (ps->buffer_size)
144                 memset(ps->data_p, '\0', (size_t)ps->buffer_size);
145 }
146
147 /*******************************************************************
148  Allocate memory when unmarshalling... Always zero clears.
149  ********************************************************************/
150
151 #if defined(PARANOID_MALLOC_CHECKER)
152 char *prs_alloc_mem_(prs_struct *ps, size_t size, unsigned int count)
153 #else
154 char *prs_alloc_mem(prs_struct *ps, size_t size, unsigned int count)
155 #endif
156 {
157         char *ret = NULL;
158
159         if (size && count) {
160                 /* We can't call the type-safe version here. */
161                 ret = (char *)_talloc_zero_array_zeronull(ps->mem_ctx, size, count,
162                                                  "parse_prs");
163         }
164         return ret;
165 }
166
167 /*******************************************************************
168  Return the current talloc context we're using.
169  ********************************************************************/
170
171 TALLOC_CTX *prs_get_mem_context(prs_struct *ps)
172 {
173         return ps->mem_ctx;
174 }
175
176 /*******************************************************************
177  Hand some already allocated memory to a prs_struct.
178  ********************************************************************/
179
180 void prs_give_memory(prs_struct *ps, char *buf, uint32 size, BOOL is_dynamic)
181 {
182         ps->is_dynamic = is_dynamic;
183         ps->data_p = buf;
184         ps->buffer_size = size;
185 }
186
187 /*******************************************************************
188  Take some memory back from a prs_struct.
189  ********************************************************************/
190
191 char *prs_take_memory(prs_struct *ps, uint32 *psize)
192 {
193         char *ret = ps->data_p;
194         if(psize)
195                 *psize = ps->buffer_size;
196         ps->is_dynamic = False;
197         prs_mem_free(ps);
198         return ret;
199 }
200
201 /*******************************************************************
202  Set a prs_struct to exactly a given size. Will grow or tuncate if neccessary.
203  ********************************************************************/
204
205 BOOL prs_set_buffer_size(prs_struct *ps, uint32 newsize)
206 {
207         if (newsize > ps->buffer_size)
208                 return prs_force_grow(ps, newsize - ps->buffer_size);
209
210         if (newsize < ps->buffer_size) {
211                 ps->buffer_size = newsize;
212
213                 /* newsize == 0 acts as a free and set pointer to NULL */
214                 if (newsize == 0) {
215                         SAFE_FREE(ps->data_p);
216                 } else {
217                         ps->data_p = (char *)SMB_REALLOC(ps->data_p, newsize);
218
219                         if (ps->data_p == NULL) {
220                                 DEBUG(0,("prs_set_buffer_size: Realloc failure for size %u.\n",
221                                         (unsigned int)newsize));
222                                 DEBUG(0,("prs_set_buffer_size: Reason %s\n",strerror(errno)));
223                                 return False;
224                         }
225                 }
226         }
227
228         return True;
229 }
230
231 /*******************************************************************
232  Attempt, if needed, to grow a data buffer.
233  Also depends on the data stream mode (io).
234  ********************************************************************/
235
236 BOOL prs_grow(prs_struct *ps, uint32 extra_space)
237 {
238         uint32 new_size;
239
240         ps->grow_size = MAX(ps->grow_size, ps->data_offset + extra_space);
241
242         if(ps->data_offset + extra_space <= ps->buffer_size)
243                 return True;
244
245         /*
246          * We cannot grow the buffer if we're not reading
247          * into the prs_struct, or if we don't own the memory.
248          */
249
250         if(UNMARSHALLING(ps) || !ps->is_dynamic) {
251                 DEBUG(0,("prs_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
252                                 (unsigned int)extra_space));
253                 return False;
254         }
255         
256         /*
257          * Decide how much extra space we really need.
258          */
259
260         extra_space -= (ps->buffer_size - ps->data_offset);
261         if(ps->buffer_size == 0) {
262                 /*
263                  * Ensure we have at least a PDU's length, or extra_space, whichever
264                  * is greater.
265                  */
266
267                 new_size = MAX(RPC_MAX_PDU_FRAG_LEN,extra_space);
268
269                 if((ps->data_p = (char *)SMB_MALLOC(new_size)) == NULL) {
270                         DEBUG(0,("prs_grow: Malloc failure for size %u.\n", (unsigned int)new_size));
271                         return False;
272                 }
273                 memset(ps->data_p, '\0', (size_t)new_size );
274         } else {
275                 /*
276                  * If the current buffer size is bigger than the space needed, just 
277                  * double it, else add extra_space.
278                  */
279                 new_size = MAX(ps->buffer_size*2, ps->buffer_size + extra_space);               
280
281                 if ((ps->data_p = (char *)SMB_REALLOC(ps->data_p, new_size)) == NULL) {
282                         DEBUG(0,("prs_grow: Realloc failure for size %u.\n",
283                                 (unsigned int)new_size));
284                         return False;
285                 }
286
287                 memset(&ps->data_p[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
288         }
289         ps->buffer_size = new_size;
290
291         return True;
292 }
293
294 /*******************************************************************
295  Attempt to force a data buffer to grow by len bytes.
296  This is only used when appending more data onto a prs_struct
297  when reading an rpc reply, before unmarshalling it.
298  ********************************************************************/
299
300 BOOL prs_force_grow(prs_struct *ps, uint32 extra_space)
301 {
302         uint32 new_size = ps->buffer_size + extra_space;
303
304         if(!UNMARSHALLING(ps) || !ps->is_dynamic) {
305                 DEBUG(0,("prs_force_grow: Buffer overflow - unable to expand buffer by %u bytes.\n",
306                                 (unsigned int)extra_space));
307                 return False;
308         }
309
310         if((ps->data_p = (char *)SMB_REALLOC(ps->data_p, new_size)) == NULL) {
311                 DEBUG(0,("prs_force_grow: Realloc failure for size %u.\n",
312                         (unsigned int)new_size));
313                 return False;
314         }
315
316         memset(&ps->data_p[ps->buffer_size], '\0', (size_t)(new_size - ps->buffer_size));
317
318         ps->buffer_size = new_size;
319
320         return True;
321 }
322
323 /*******************************************************************
324  Get the data pointer (external interface).
325 ********************************************************************/
326
327 char *prs_data_p(prs_struct *ps)
328 {
329         return ps->data_p;
330 }
331
332 /*******************************************************************
333  Get the current data size (external interface).
334  ********************************************************************/
335
336 uint32 prs_data_size(prs_struct *ps)
337 {
338         return ps->buffer_size;
339 }
340
341 /*******************************************************************
342  Fetch the current offset (external interface).
343  ********************************************************************/
344
345 uint32 prs_offset(prs_struct *ps)
346 {
347         return ps->data_offset;
348 }
349
350 /*******************************************************************
351  Set the current offset (external interface).
352  ********************************************************************/
353
354 BOOL prs_set_offset(prs_struct *ps, uint32 offset)
355 {
356         if(offset <= ps->data_offset) {
357                 ps->data_offset = offset;
358                 return True;
359         }
360
361         if(!prs_grow(ps, offset - ps->data_offset))
362                 return False;
363
364         ps->data_offset = offset;
365         return True;
366 }
367
368 /*******************************************************************
369  Append the data from one parse_struct into another.
370  ********************************************************************/
371
372 BOOL prs_append_prs_data(prs_struct *dst, prs_struct *src)
373 {
374         if (prs_offset(src) == 0)
375                 return True;
376
377         if(!prs_grow(dst, prs_offset(src)))
378                 return False;
379
380         memcpy(&dst->data_p[dst->data_offset], src->data_p, (size_t)prs_offset(src));
381         dst->data_offset += prs_offset(src);
382
383         return True;
384 }
385
386 /*******************************************************************
387  Append some data from one parse_struct into another.
388  ********************************************************************/
389
390 BOOL prs_append_some_prs_data(prs_struct *dst, prs_struct *src, int32 start, uint32 len)
391 {       
392         if (len == 0)
393                 return True;
394
395         if(!prs_grow(dst, len))
396                 return False;
397         
398         memcpy(&dst->data_p[dst->data_offset], src->data_p + start, (size_t)len);
399         dst->data_offset += len;
400
401         return True;
402 }
403
404 /*******************************************************************
405  Append the data from a buffer into a parse_struct.
406  ********************************************************************/
407
408 BOOL prs_copy_data_in(prs_struct *dst, const char *src, uint32 len)
409 {
410         if (len == 0)
411                 return True;
412
413         if(!prs_grow(dst, len))
414                 return False;
415
416         memcpy(&dst->data_p[dst->data_offset], src, (size_t)len);
417         dst->data_offset += len;
418
419         return True;
420 }
421
422 /*******************************************************************
423  Copy some data from a parse_struct into a buffer.
424  ********************************************************************/
425
426 BOOL prs_copy_data_out(char *dst, prs_struct *src, uint32 len)
427 {
428         if (len == 0)
429                 return True;
430
431         if(!prs_mem_get(src, len))
432                 return False;
433
434         memcpy(dst, &src->data_p[src->data_offset], (size_t)len);
435         src->data_offset += len;
436
437         return True;
438 }
439
440 /*******************************************************************
441  Copy all the data from a parse_struct into a buffer.
442  ********************************************************************/
443
444 BOOL prs_copy_all_data_out(char *dst, prs_struct *src)
445 {
446         uint32 len = prs_offset(src);
447
448         if (!len)
449                 return True;
450
451         prs_set_offset(src, 0);
452         return prs_copy_data_out(dst, src, len);
453 }
454
455 /*******************************************************************
456  Set the data as X-endian (external interface).
457  ********************************************************************/
458
459 void prs_set_endian_data(prs_struct *ps, BOOL endian)
460 {
461         ps->bigendian_data = endian;
462 }
463
464 /*******************************************************************
465  Align a the data_len to a multiple of align bytes - filling with
466  zeros.
467  ********************************************************************/
468
469 BOOL prs_align(prs_struct *ps)
470 {
471         uint32 mod = ps->data_offset & (ps->align-1);
472
473         if (ps->align != 0 && mod != 0) {
474                 uint32 extra_space = (ps->align - mod);
475                 if(!prs_grow(ps, extra_space))
476                         return False;
477                 memset(&ps->data_p[ps->data_offset], '\0', (size_t)extra_space);
478                 ps->data_offset += extra_space;
479         }
480
481         return True;
482 }
483
484 /******************************************************************
485  Align on a 2 byte boundary
486  *****************************************************************/
487  
488 BOOL prs_align_uint16(prs_struct *ps)
489 {
490         BOOL ret;
491         uint8 old_align = ps->align;
492
493         ps->align = 2;
494         ret = prs_align(ps);
495         ps->align = old_align;
496         
497         return ret;
498 }
499
500 /******************************************************************
501  Align on a 8 byte boundary
502  *****************************************************************/
503  
504 BOOL prs_align_uint64(prs_struct *ps)
505 {
506         BOOL ret;
507         uint8 old_align = ps->align;
508
509         ps->align = 8;
510         ret = prs_align(ps);
511         ps->align = old_align;
512         
513         return ret;
514 }
515
516 /******************************************************************
517  Align on a specific byte boundary
518  *****************************************************************/
519  
520 BOOL prs_align_custom(prs_struct *ps, uint8 boundary)
521 {
522         BOOL ret;
523         uint8 old_align = ps->align;
524
525         ps->align = boundary;
526         ret = prs_align(ps);
527         ps->align = old_align;
528         
529         return ret;
530 }
531
532
533
534 /*******************************************************************
535  Align only if required (for the unistr2 string mainly)
536  ********************************************************************/
537
538 BOOL prs_align_needed(prs_struct *ps, uint32 needed)
539 {
540         if (needed==0)
541                 return True;
542         else
543                 return prs_align(ps);
544 }
545
546 /*******************************************************************
547  Ensure we can read/write to a given offset.
548  ********************************************************************/
549
550 char *prs_mem_get(prs_struct *ps, uint32 extra_size)
551 {
552         if(UNMARSHALLING(ps)) {
553                 /*
554                  * If reading, ensure that we can read the requested size item.
555                  */
556                 if (ps->data_offset + extra_size > ps->buffer_size) {
557                         DEBUG(0,("prs_mem_get: reading data of size %u would overrun "
558                                 "buffer by %u bytes.\n",
559                                 (unsigned int)extra_size,
560                                 (unsigned int)(ps->data_offset + extra_size - ps->buffer_size) ));
561                         return NULL;
562                 }
563         } else {
564                 /*
565                  * Writing - grow the buffer if needed.
566                  */
567                 if(!prs_grow(ps, extra_size))
568                         return NULL;
569         }
570         return &ps->data_p[ps->data_offset];
571 }
572
573 /*******************************************************************
574  Change the struct type.
575  ********************************************************************/
576
577 void prs_switch_type(prs_struct *ps, BOOL io)
578 {
579         if ((ps->io ^ io) == True)
580                 ps->io=io;
581 }
582
583 /*******************************************************************
584  Force a prs_struct to be dynamic even when it's size is 0.
585  ********************************************************************/
586
587 void prs_force_dynamic(prs_struct *ps)
588 {
589         ps->is_dynamic=True;
590 }
591
592 /*******************************************************************
593  Associate a session key with a parse struct.
594  ********************************************************************/
595
596 void prs_set_session_key(prs_struct *ps, const char sess_key[16])
597 {
598         ps->sess_key = sess_key;
599 }
600
601 /*******************************************************************
602  Stream a uint8.
603  ********************************************************************/
604
605 BOOL prs_uint8(const char *name, prs_struct *ps, int depth, uint8 *data8)
606 {
607         char *q = prs_mem_get(ps, 1);
608         if (q == NULL)
609                 return False;
610
611         if (UNMARSHALLING(ps))
612                 *data8 = CVAL(q,0);
613         else
614                 SCVAL(q,0,*data8);
615
616         DEBUG(5,("%s%04x %s: %02x\n", tab_depth(depth), ps->data_offset, name, *data8));
617
618         ps->data_offset += 1;
619
620         return True;
621 }
622
623 /*******************************************************************
624  Stream a uint16* (allocate memory if unmarshalling)
625  ********************************************************************/
626
627 BOOL prs_pointer( const char *name, prs_struct *ps, int depth, 
628                  void *dta, size_t data_size,
629                  BOOL(*prs_fn)(const char*, prs_struct*, int, void*) )
630 {
631         void ** data = (void **)dta;
632         uint32 data_p;
633
634         /* output f000baaa to stream if the pointer is non-zero. */
635
636         data_p = *data ? 0xf000baaa : 0;
637
638         if ( !prs_uint32("ptr", ps, depth, &data_p ))
639                 return False;
640
641         /* we're done if there is no data */
642
643         if ( !data_p )
644                 return True;
645
646         if (UNMARSHALLING(ps)) {
647                 if (data_size) {
648                         if ( !(*data = PRS_ALLOC_MEM(ps, char, data_size)) )
649                                 return False;
650                 } else {
651                         *data = NULL;
652                 }
653         }
654
655         return prs_fn(name, ps, depth, *data);
656 }
657
658
659 /*******************************************************************
660  Stream a uint16.
661  ********************************************************************/
662
663 BOOL prs_uint16(const char *name, prs_struct *ps, int depth, uint16 *data16)
664 {
665         char *q = prs_mem_get(ps, sizeof(uint16));
666         if (q == NULL)
667                 return False;
668
669         if (UNMARSHALLING(ps)) {
670                 if (ps->bigendian_data)
671                         *data16 = RSVAL(q,0);
672                 else
673                         *data16 = SVAL(q,0);
674         } else {
675                 if (ps->bigendian_data)
676                         RSSVAL(q,0,*data16);
677                 else
678                         SSVAL(q,0,*data16);
679         }
680
681         DEBUG(5,("%s%04x %s: %04x\n", tab_depth(depth), ps->data_offset, name, *data16));
682
683         ps->data_offset += sizeof(uint16);
684
685         return True;
686 }
687
688 /*******************************************************************
689  Stream a uint32.
690  ********************************************************************/
691
692 BOOL prs_uint32(const char *name, prs_struct *ps, int depth, uint32 *data32)
693 {
694         char *q = prs_mem_get(ps, sizeof(uint32));
695         if (q == NULL)
696                 return False;
697
698         if (UNMARSHALLING(ps)) {
699                 if (ps->bigendian_data)
700                         *data32 = RIVAL(q,0);
701                 else
702                         *data32 = IVAL(q,0);
703         } else {
704                 if (ps->bigendian_data)
705                         RSIVAL(q,0,*data32);
706                 else
707                         SIVAL(q,0,*data32);
708         }
709
710         DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth), ps->data_offset, name, *data32));
711
712         ps->data_offset += sizeof(uint32);
713
714         return True;
715 }
716
717 /*******************************************************************
718  Stream an int32.
719  ********************************************************************/
720
721 BOOL prs_int32(const char *name, prs_struct *ps, int depth, int32 *data32)
722 {
723         char *q = prs_mem_get(ps, sizeof(int32));
724         if (q == NULL)
725                 return False;
726
727         if (UNMARSHALLING(ps)) {
728                 if (ps->bigendian_data)
729                         *data32 = RIVALS(q,0);
730                 else
731                         *data32 = IVALS(q,0);
732         } else {
733                 if (ps->bigendian_data)
734                         RSIVALS(q,0,*data32);
735                 else
736                         SIVALS(q,0,*data32);
737         }
738
739         DEBUG(5,("%s%04x %s: %08x\n", tab_depth(depth), ps->data_offset, name, *data32));
740
741         ps->data_offset += sizeof(int32);
742
743         return True;
744 }
745
746 /*******************************************************************
747  Stream a NTSTATUS
748  ********************************************************************/
749
750 BOOL prs_ntstatus(const char *name, prs_struct *ps, int depth, NTSTATUS *status)
751 {
752         char *q = prs_mem_get(ps, sizeof(uint32));
753         if (q == NULL)
754                 return False;
755
756         if (UNMARSHALLING(ps)) {
757                 if (ps->bigendian_data)
758                         *status = NT_STATUS(RIVAL(q,0));
759                 else
760                         *status = NT_STATUS(IVAL(q,0));
761         } else {
762                 if (ps->bigendian_data)
763                         RSIVAL(q,0,NT_STATUS_V(*status));
764                 else
765                         SIVAL(q,0,NT_STATUS_V(*status));
766         }
767
768         DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name, 
769                  nt_errstr(*status)));
770
771         ps->data_offset += sizeof(uint32);
772
773         return True;
774 }
775
776 /*******************************************************************
777  Stream a DCE error code
778  ********************************************************************/
779
780 BOOL prs_dcerpc_status(const char *name, prs_struct *ps, int depth, NTSTATUS *status)
781 {
782         char *q = prs_mem_get(ps, sizeof(uint32));
783         if (q == NULL)
784                 return False;
785
786         if (UNMARSHALLING(ps)) {
787                 if (ps->bigendian_data)
788                         *status = NT_STATUS(RIVAL(q,0));
789                 else
790                         *status = NT_STATUS(IVAL(q,0));
791         } else {
792                 if (ps->bigendian_data)
793                         RSIVAL(q,0,NT_STATUS_V(*status));
794                 else
795                         SIVAL(q,0,NT_STATUS_V(*status));
796         }
797
798         DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name, 
799                  dcerpc_errstr(NT_STATUS_V(*status))));
800
801         ps->data_offset += sizeof(uint32);
802
803         return True;
804 }
805
806
807 /*******************************************************************
808  Stream a WERROR
809  ********************************************************************/
810
811 BOOL prs_werror(const char *name, prs_struct *ps, int depth, WERROR *status)
812 {
813         char *q = prs_mem_get(ps, sizeof(uint32));
814         if (q == NULL)
815                 return False;
816
817         if (UNMARSHALLING(ps)) {
818                 if (ps->bigendian_data)
819                         *status = W_ERROR(RIVAL(q,0));
820                 else
821                         *status = W_ERROR(IVAL(q,0));
822         } else {
823                 if (ps->bigendian_data)
824                         RSIVAL(q,0,W_ERROR_V(*status));
825                 else
826                         SIVAL(q,0,W_ERROR_V(*status));
827         }
828
829         DEBUG(5,("%s%04x %s: %s\n", tab_depth(depth), ps->data_offset, name, 
830                  dos_errstr(*status)));
831
832         ps->data_offset += sizeof(uint32);
833
834         return True;
835 }
836
837
838 /******************************************************************
839  Stream an array of uint8s. Length is number of uint8s.
840  ********************************************************************/
841
842 BOOL prs_uint8s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint8 *data8s, int len)
843 {
844         int i;
845         char *q = prs_mem_get(ps, len);
846         if (q == NULL)
847                 return False;
848
849         if (UNMARSHALLING(ps)) {
850                 for (i = 0; i < len; i++)
851                         data8s[i] = CVAL(q,i);
852         } else {
853                 for (i = 0; i < len; i++)
854                         SCVAL(q, i, data8s[i]);
855         }
856
857         DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset ,name));
858         if (charmode)
859                 print_asc(5, (unsigned char*)data8s, len);
860         else {
861                 for (i = 0; i < len; i++)
862                         DEBUG(5,("%02x ", data8s[i]));
863         }
864         DEBUG(5,("\n"));
865
866         ps->data_offset += len;
867
868         return True;
869 }
870
871 /******************************************************************
872  Stream an array of uint16s. Length is number of uint16s.
873  ********************************************************************/
874
875 BOOL prs_uint16s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
876 {
877         int i;
878         char *q = prs_mem_get(ps, len * sizeof(uint16));
879         if (q == NULL)
880                 return False;
881
882         if (UNMARSHALLING(ps)) {
883                 if (ps->bigendian_data) {
884                         for (i = 0; i < len; i++)
885                                 data16s[i] = RSVAL(q, 2*i);
886                 } else {
887                         for (i = 0; i < len; i++)
888                                 data16s[i] = SVAL(q, 2*i);
889                 }
890         } else {
891                 if (ps->bigendian_data) {
892                         for (i = 0; i < len; i++)
893                                 RSSVAL(q, 2*i, data16s[i]);
894                 } else {
895                         for (i = 0; i < len; i++)
896                                 SSVAL(q, 2*i, data16s[i]);
897                 }
898         }
899
900         DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
901         if (charmode)
902                 print_asc(5, (unsigned char*)data16s, 2*len);
903         else {
904                 for (i = 0; i < len; i++)
905                         DEBUG(5,("%04x ", data16s[i]));
906         }
907         DEBUG(5,("\n"));
908
909         ps->data_offset += (len * sizeof(uint16));
910
911         return True;
912 }
913
914 /******************************************************************
915  Start using a function for streaming unicode chars. If unmarshalling,
916  output must be little-endian, if marshalling, input must be little-endian.
917  ********************************************************************/
918
919 static void dbg_rw_punival(BOOL charmode, const char *name, int depth, prs_struct *ps,
920                                                         char *in_buf, char *out_buf, int len)
921 {
922         int i;
923
924         if (UNMARSHALLING(ps)) {
925                 if (ps->bigendian_data) {
926                         for (i = 0; i < len; i++)
927                                 SSVAL(out_buf,2*i,RSVAL(in_buf, 2*i));
928                 } else {
929                         for (i = 0; i < len; i++)
930                                 SSVAL(out_buf, 2*i, SVAL(in_buf, 2*i));
931                 }
932         } else {
933                 if (ps->bigendian_data) {
934                         for (i = 0; i < len; i++)
935                                 RSSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
936                 } else {
937                         for (i = 0; i < len; i++)
938                                 SSVAL(in_buf, 2*i, SVAL(out_buf,2*i));
939                 }
940         }
941
942         DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
943         if (charmode)
944                 print_asc(5, (unsigned char*)out_buf, 2*len);
945         else {
946                 for (i = 0; i < len; i++)
947                         DEBUG(5,("%04x ", out_buf[i]));
948         }
949         DEBUG(5,("\n"));
950 }
951
952 /******************************************************************
953  Stream a unistr. Always little endian.
954  ********************************************************************/
955
956 BOOL prs_uint16uni(BOOL charmode, const char *name, prs_struct *ps, int depth, uint16 *data16s, int len)
957 {
958         char *q = prs_mem_get(ps, len * sizeof(uint16));
959         if (q == NULL)
960                 return False;
961
962         dbg_rw_punival(charmode, name, depth, ps, q, (char *)data16s, len);
963         ps->data_offset += (len * sizeof(uint16));
964
965         return True;
966 }
967
968 /******************************************************************
969  Stream an array of uint32s. Length is number of uint32s.
970  ********************************************************************/
971
972 BOOL prs_uint32s(BOOL charmode, const char *name, prs_struct *ps, int depth, uint32 *data32s, int len)
973 {
974         int i;
975         char *q = prs_mem_get(ps, len * sizeof(uint32));
976         if (q == NULL)
977                 return False;
978
979         if (UNMARSHALLING(ps)) {
980                 if (ps->bigendian_data) {
981                         for (i = 0; i < len; i++)
982                                 data32s[i] = RIVAL(q, 4*i);
983                 } else {
984                         for (i = 0; i < len; i++)
985                                 data32s[i] = IVAL(q, 4*i);
986                 }
987         } else {
988                 if (ps->bigendian_data) {
989                         for (i = 0; i < len; i++)
990                                 RSIVAL(q, 4*i, data32s[i]);
991                 } else {
992                         for (i = 0; i < len; i++)
993                                 SIVAL(q, 4*i, data32s[i]);
994                 }
995         }
996
997         DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
998         if (charmode)
999                 print_asc(5, (unsigned char*)data32s, 4*len);
1000         else {
1001                 for (i = 0; i < len; i++)
1002                         DEBUG(5,("%08x ", data32s[i]));
1003         }
1004         DEBUG(5,("\n"));
1005
1006         ps->data_offset += (len * sizeof(uint32));
1007
1008         return True;
1009 }
1010
1011 /******************************************************************
1012  Stream an array of unicode string, length/buffer specified separately,
1013  in uint16 chars. The unicode string is already in little-endian format.
1014  ********************************************************************/
1015
1016 BOOL prs_buffer5(BOOL charmode, const char *name, prs_struct *ps, int depth, BUFFER5 *str)
1017 {
1018         char *p;
1019         char *q = prs_mem_get(ps, str->buf_len * sizeof(uint16));
1020         if (q == NULL)
1021                 return False;
1022
1023         /* If the string is empty, we don't have anything to stream */
1024         if (str->buf_len==0)
1025                 return True;
1026
1027         if (UNMARSHALLING(ps)) {
1028                 str->buffer = PRS_ALLOC_MEM(ps,uint16,str->buf_len);
1029                 if (str->buffer == NULL)
1030                         return False;
1031         }
1032
1033         p = (char *)str->buffer;
1034
1035         dbg_rw_punival(charmode, name, depth, ps, q, p, str->buf_len);
1036         
1037         ps->data_offset += (str->buf_len * sizeof(uint16));
1038
1039         return True;
1040 }
1041
1042 /******************************************************************
1043  Stream a "not" unicode string, length/buffer specified separately,
1044  in byte chars. String is in little-endian format.
1045  ********************************************************************/
1046
1047 BOOL prs_regval_buffer(BOOL charmode, const char *name, prs_struct *ps, int depth, REGVAL_BUFFER *buf)
1048 {
1049         char *p;
1050         char *q = prs_mem_get(ps, buf->buf_len);
1051         if (q == NULL)
1052                 return False;
1053
1054         if (UNMARSHALLING(ps)) {
1055                 if (buf->buf_len > buf->buf_max_len) {
1056                         return False;
1057                 }
1058                 if ( buf->buf_max_len ) {
1059                         buf->buffer = PRS_ALLOC_MEM(ps, uint16, buf->buf_max_len);
1060                         if ( buf->buffer == NULL )
1061                                 return False;
1062                 } else {
1063                         buf->buffer = NULL;
1064                 }
1065         }
1066
1067         p = (char *)buf->buffer;
1068
1069         dbg_rw_punival(charmode, name, depth, ps, q, p, buf->buf_len/2);
1070         ps->data_offset += buf->buf_len;
1071
1072         return True;
1073 }
1074
1075 /******************************************************************
1076  Stream a string, length/buffer specified separately,
1077  in uint8 chars.
1078  ********************************************************************/
1079
1080 BOOL prs_string2(BOOL charmode, const char *name, prs_struct *ps, int depth, STRING2 *str)
1081 {
1082         unsigned int i;
1083         char *q = prs_mem_get(ps, str->str_str_len);
1084         if (q == NULL)
1085                 return False;
1086
1087         if (UNMARSHALLING(ps)) {
1088                 if (str->str_str_len > str->str_max_len) {
1089                         return False;
1090                 }
1091                 if (str->str_max_len) {
1092                         str->buffer = PRS_ALLOC_MEM(ps,unsigned char, str->str_max_len);
1093                         if (str->buffer == NULL)
1094                                 return False;
1095                 } else {
1096                         str->buffer = NULL;
1097                 }
1098         }
1099
1100         if (UNMARSHALLING(ps)) {
1101                 for (i = 0; i < str->str_str_len; i++)
1102                         str->buffer[i] = CVAL(q,i);
1103         } else {
1104                 for (i = 0; i < str->str_str_len; i++)
1105                         SCVAL(q, i, str->buffer[i]);
1106         }
1107
1108         DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1109         if (charmode)
1110                 print_asc(5, (unsigned char*)str->buffer, str->str_str_len);
1111         else {
1112                 for (i = 0; i < str->str_str_len; i++)
1113                         DEBUG(5,("%02x ", str->buffer[i]));
1114         }
1115         DEBUG(5,("\n"));
1116
1117         ps->data_offset += str->str_str_len;
1118
1119         return True;
1120 }
1121
1122 /******************************************************************
1123  Stream a unicode string, length/buffer specified separately,
1124  in uint16 chars. The unicode string is already in little-endian format.
1125  ********************************************************************/
1126
1127 BOOL prs_unistr2(BOOL charmode, const char *name, prs_struct *ps, int depth, UNISTR2 *str)
1128 {
1129         char *p;
1130         char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1131         if (q == NULL)
1132                 return False;
1133
1134         /* If the string is empty, we don't have anything to stream */
1135         if (str->uni_str_len==0)
1136                 return True;
1137
1138         if (UNMARSHALLING(ps)) {
1139                 if (str->uni_str_len > str->uni_max_len) {
1140                         return False;
1141                 }
1142                 if (str->uni_max_len) {
1143                         str->buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_max_len);
1144                         if (str->buffer == NULL)
1145                                 return False;
1146                 } else {
1147                         str->buffer = NULL;
1148                 }
1149         }
1150
1151         p = (char *)str->buffer;
1152
1153         dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1154         
1155         ps->data_offset += (str->uni_str_len * sizeof(uint16));
1156
1157         return True;
1158 }
1159
1160 /******************************************************************
1161  Stream a unicode string, length/buffer specified separately,
1162  in uint16 chars. The unicode string is already in little-endian format.
1163  ********************************************************************/
1164
1165 BOOL prs_unistr3(BOOL charmode, const char *name, UNISTR3 *str, prs_struct *ps, int depth)
1166 {
1167         char *p;
1168         char *q = prs_mem_get(ps, str->uni_str_len * sizeof(uint16));
1169         if (q == NULL)
1170                 return False;
1171
1172         if (UNMARSHALLING(ps)) {
1173                 if (str->uni_str_len) {
1174                         str->str.buffer = PRS_ALLOC_MEM(ps,uint16,str->uni_str_len);
1175                         if (str->str.buffer == NULL)
1176                                 return False;
1177                 } else {
1178                         str->str.buffer = NULL;
1179                 }
1180         }
1181
1182         p = (char *)str->str.buffer;
1183
1184         dbg_rw_punival(charmode, name, depth, ps, q, p, str->uni_str_len);
1185         ps->data_offset += (str->uni_str_len * sizeof(uint16));
1186
1187         return True;
1188 }
1189
1190 /*******************************************************************
1191  Stream a unicode  null-terminated string. As the string is already
1192  in little-endian format then do it as a stream of bytes.
1193  ********************************************************************/
1194
1195 BOOL prs_unistr(const char *name, prs_struct *ps, int depth, UNISTR *str)
1196 {
1197         unsigned int len = 0;
1198         unsigned char *p = (unsigned char *)str->buffer;
1199         uint8 *start;
1200         char *q;
1201         uint32 max_len;
1202         uint16* ptr;
1203
1204         if (MARSHALLING(ps)) {
1205
1206                 for(len = 0; str->buffer[len] != 0; len++)
1207                         ;
1208
1209                 q = prs_mem_get(ps, (len+1)*2);
1210                 if (q == NULL)
1211                         return False;
1212
1213                 start = (uint8*)q;
1214
1215                 for(len = 0; str->buffer[len] != 0; len++) {
1216                         if(ps->bigendian_data) {
1217                                 /* swap bytes - p is little endian, q is big endian. */
1218                                 q[0] = (char)p[1];
1219                                 q[1] = (char)p[0];
1220                                 p += 2;
1221                                 q += 2;
1222                         } 
1223                         else 
1224                         {
1225                                 q[0] = (char)p[0];
1226                                 q[1] = (char)p[1];
1227                                 p += 2;
1228                                 q += 2;
1229                         }
1230                 }
1231
1232                 /*
1233                  * even if the string is 'empty' (only an \0 char)
1234                  * at this point the leading \0 hasn't been parsed.
1235                  * so parse it now
1236                  */
1237
1238                 q[0] = 0;
1239                 q[1] = 0;
1240                 q += 2;
1241
1242                 len++;
1243
1244                 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1245                 print_asc(5, (unsigned char*)start, 2*len);     
1246                 DEBUG(5, ("\n"));
1247         }
1248         else { /* unmarshalling */
1249         
1250                 uint32 alloc_len = 0;
1251                 q = ps->data_p + prs_offset(ps);
1252
1253                 /*
1254                  * Work out how much space we need and talloc it.
1255                  */
1256                 max_len = (ps->buffer_size - ps->data_offset)/sizeof(uint16);
1257
1258                 /* the test of the value of *ptr helps to catch the circumstance
1259                    where we have an emtpty (non-existent) string in the buffer */
1260                 for ( ptr = (uint16 *)q; *ptr++ && (alloc_len <= max_len); alloc_len++)
1261                         /* do nothing */ 
1262                         ;
1263
1264                 if (alloc_len < max_len)
1265                         alloc_len += 1;
1266
1267                 /* should we allocate anything at all? */
1268                 str->buffer = PRS_ALLOC_MEM(ps,uint16,alloc_len);
1269                 if ((str->buffer == NULL) && (alloc_len > 0))
1270                         return False;
1271
1272                 p = (unsigned char *)str->buffer;
1273
1274                 len = 0;
1275                 /* the (len < alloc_len) test is to prevent us from overwriting
1276                    memory that is not ours...if we get that far, we have a non-null
1277                    terminated string in the buffer and have messed up somewhere */
1278                 while ((len < alloc_len) && (*(uint16 *)q != 0)) {
1279                         if(ps->bigendian_data) 
1280                         {
1281                                 /* swap bytes - q is big endian, p is little endian. */
1282                                 p[0] = (unsigned char)q[1];
1283                                 p[1] = (unsigned char)q[0];
1284                                 p += 2;
1285                                 q += 2;
1286                         } else {
1287
1288                                 p[0] = (unsigned char)q[0];
1289                                 p[1] = (unsigned char)q[1];
1290                                 p += 2;
1291                                 q += 2;
1292                         }
1293
1294                         len++;
1295                 } 
1296                 if (len < alloc_len) {
1297                         /* NULL terminate the UNISTR */
1298                         str->buffer[len++] = '\0';
1299                 }
1300
1301                 DEBUG(5,("%s%04x %s: ", tab_depth(depth), ps->data_offset, name));
1302                 print_asc(5, (unsigned char*)str->buffer, 2*len);       
1303                 DEBUG(5, ("\n"));
1304         }
1305
1306         /* set the offset in the prs_struct; 'len' points to the
1307            terminiating NULL in the UNISTR so we need to go one more
1308            uint16 */
1309         ps->data_offset += (len)*2;
1310         
1311         return True;
1312 }
1313
1314
1315 /*******************************************************************
1316  Stream a null-terminated string.  len is strlen, and therefore does
1317  not include the null-termination character.
1318  ********************************************************************/
1319
1320 BOOL prs_string(const char *name, prs_struct *ps, int depth, char *str, int max_buf_size)
1321 {
1322         char *q;
1323         int i;
1324         int len;
1325
1326         if (UNMARSHALLING(ps))
1327                 len = strlen(&ps->data_p[ps->data_offset]);
1328         else
1329                 len = strlen(str);
1330
1331         len = MIN(len, (max_buf_size-1));
1332
1333         q = prs_mem_get(ps, len+1);
1334         if (q == NULL)
1335                 return False;
1336
1337         for(i = 0; i < len; i++) {
1338                 if (UNMARSHALLING(ps))
1339                         str[i] = q[i];
1340                 else
1341                         q[i] = str[i];
1342         }
1343
1344         /* The terminating null. */
1345         str[i] = '\0';
1346
1347         if (MARSHALLING(ps)) {
1348                 q[i] = '\0';
1349         }
1350
1351         ps->data_offset += len+1;
1352
1353         dump_data(5+depth, (uint8 *)q, len);
1354
1355         return True;
1356 }
1357
1358 BOOL prs_string_alloc(const char *name, prs_struct *ps, int depth, const char **str)
1359 {
1360         size_t len;
1361         char *tmp_str;
1362
1363         if (UNMARSHALLING(ps)) {
1364                 len = strlen(&ps->data_p[ps->data_offset]);
1365         } else {
1366                 len = strlen(*str);
1367         }
1368
1369         tmp_str = PRS_ALLOC_MEM(ps, char, len+1);
1370
1371         if (tmp_str == NULL) {
1372                 return False;
1373         }
1374
1375         if (MARSHALLING(ps)) {
1376                 strncpy(tmp_str, *str, len);
1377         }
1378
1379         if (!prs_string(name, ps, depth, tmp_str, len+1)) {
1380                 return False;
1381         }
1382
1383         *str = tmp_str;
1384         return True;
1385 }
1386
1387 /*******************************************************************
1388  prs_uint16 wrapper. Call this and it sets up a pointer to where the
1389  uint16 should be stored, or gets the size if reading.
1390  ********************************************************************/
1391
1392 BOOL prs_uint16_pre(const char *name, prs_struct *ps, int depth, uint16 *data16, uint32 *offset)
1393 {
1394         *offset = ps->data_offset;
1395         if (UNMARSHALLING(ps)) {
1396                 /* reading. */
1397                 return prs_uint16(name, ps, depth, data16);
1398         } else {
1399                 char *q = prs_mem_get(ps, sizeof(uint16));
1400                 if(q ==NULL)
1401                         return False;
1402                 ps->data_offset += sizeof(uint16);
1403         }
1404         return True;
1405 }
1406
1407 /*******************************************************************
1408  prs_uint16 wrapper.  call this and it retrospectively stores the size.
1409  does nothing on reading, as that is already handled by ...._pre()
1410  ********************************************************************/
1411
1412 BOOL prs_uint16_post(const char *name, prs_struct *ps, int depth, uint16 *data16,
1413                                 uint32 ptr_uint16, uint32 start_offset)
1414 {
1415         if (MARSHALLING(ps)) {
1416                 /* 
1417                  * Writing - temporarily move the offset pointer.
1418                  */
1419                 uint16 data_size = ps->data_offset - start_offset;
1420                 uint32 old_offset = ps->data_offset;
1421
1422                 ps->data_offset = ptr_uint16;
1423                 if(!prs_uint16(name, ps, depth, &data_size)) {
1424                         ps->data_offset = old_offset;
1425                         return False;
1426                 }
1427                 ps->data_offset = old_offset;
1428         } else {
1429                 ps->data_offset = start_offset + (uint32)(*data16);
1430         }
1431         return True;
1432 }
1433
1434 /*******************************************************************
1435  prs_uint32 wrapper. Call this and it sets up a pointer to where the
1436  uint32 should be stored, or gets the size if reading.
1437  ********************************************************************/
1438
1439 BOOL prs_uint32_pre(const char *name, prs_struct *ps, int depth, uint32 *data32, uint32 *offset)
1440 {
1441         *offset = ps->data_offset;
1442         if (UNMARSHALLING(ps) && (data32 != NULL)) {
1443                 /* reading. */
1444                 return prs_uint32(name, ps, depth, data32);
1445         } else {
1446                 ps->data_offset += sizeof(uint32);
1447         }
1448         return True;
1449 }
1450
1451 /*******************************************************************
1452  prs_uint32 wrapper.  call this and it retrospectively stores the size.
1453  does nothing on reading, as that is already handled by ...._pre()
1454  ********************************************************************/
1455
1456 BOOL prs_uint32_post(const char *name, prs_struct *ps, int depth, uint32 *data32,
1457                                 uint32 ptr_uint32, uint32 data_size)
1458 {
1459         if (MARSHALLING(ps)) {
1460                 /* 
1461                  * Writing - temporarily move the offset pointer.
1462                  */
1463                 uint32 old_offset = ps->data_offset;
1464                 ps->data_offset = ptr_uint32;
1465                 if(!prs_uint32(name, ps, depth, &data_size)) {
1466                         ps->data_offset = old_offset;
1467                         return False;
1468                 }
1469                 ps->data_offset = old_offset;
1470         }
1471         return True;
1472 }
1473
1474 /* useful function to store a structure in rpc wire format */
1475 int tdb_prs_store(TDB_CONTEXT *tdb, TDB_DATA kbuf, prs_struct *ps)
1476 {
1477         TDB_DATA dbuf;
1478         dbuf.dptr = (uint8 *)ps->data_p;
1479         dbuf.dsize = prs_offset(ps);
1480         return tdb_trans_store(tdb, kbuf, dbuf, TDB_REPLACE);
1481 }
1482
1483 int tdb_prs_store_bystring(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps)
1484 {
1485         TDB_DATA kbuf = string_term_tdb_data(keystr);
1486         return tdb_prs_store(tdb, kbuf, ps);
1487 }
1488
1489 /* useful function to fetch a structure into rpc wire format */
1490 int tdb_prs_fetch(TDB_CONTEXT *tdb, TDB_DATA kbuf, prs_struct *ps, TALLOC_CTX *mem_ctx)
1491 {
1492         TDB_DATA dbuf;
1493
1494         prs_init(ps, 0, mem_ctx, UNMARSHALL);
1495
1496         dbuf = tdb_fetch(tdb, kbuf);
1497         if (!dbuf.dptr)
1498                 return -1;
1499
1500         prs_give_memory(ps, (char *)dbuf.dptr, dbuf.dsize, True);
1501
1502         return 0;
1503
1504
1505 int tdb_prs_fetch_bystring(TDB_CONTEXT *tdb, char *keystr, prs_struct *ps, TALLOC_CTX *mem_ctx)
1506 {
1507         TDB_DATA kbuf = string_term_tdb_data(keystr);
1508         return tdb_prs_fetch(tdb, kbuf, ps, mem_ctx);
1509 }
1510
1511 /*******************************************************************
1512  hash a stream.
1513  ********************************************************************/
1514
1515 BOOL prs_hash1(prs_struct *ps, uint32 offset, int len)
1516 {
1517         char *q;
1518
1519         q = ps->data_p;
1520         q = &q[offset];
1521
1522 #ifdef DEBUG_PASSWORD
1523         DEBUG(100, ("prs_hash1\n"));
1524         dump_data(100, (uint8 *)ps->sess_key, 16);
1525         dump_data(100, (uint8 *)q, len);
1526 #endif
1527         SamOEMhash((uchar *) q, (const unsigned char *)ps->sess_key, len);
1528
1529 #ifdef DEBUG_PASSWORD
1530         dump_data(100, (uint8 *)q, len);
1531 #endif
1532
1533         return True;
1534 }
1535
1536 /*******************************************************************
1537  Create a digest over the entire packet (including the data), and 
1538  MD5 it with the session key.
1539  ********************************************************************/
1540
1541 static void schannel_digest(struct schannel_auth_struct *a,
1542                           enum pipe_auth_level auth_level,
1543                           RPC_AUTH_SCHANNEL_CHK * verf,
1544                           char *data, size_t data_len,
1545                           uchar digest_final[16]) 
1546 {
1547         uchar whole_packet_digest[16];
1548         static uchar zeros[4];
1549         struct MD5Context ctx3;
1550         
1551         /* verfiy the signature on the packet by MD5 over various bits */
1552         MD5Init(&ctx3);
1553         /* use our sequence number, which ensures the packet is not
1554            out of order */
1555         MD5Update(&ctx3, zeros, sizeof(zeros));
1556         MD5Update(&ctx3, verf->sig, sizeof(verf->sig));
1557         if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1558                 MD5Update(&ctx3, verf->confounder, sizeof(verf->confounder));
1559         }
1560         MD5Update(&ctx3, (const unsigned char *)data, data_len);
1561         MD5Final(whole_packet_digest, &ctx3);
1562         dump_data_pw("whole_packet_digest:\n", whole_packet_digest, sizeof(whole_packet_digest));
1563         
1564         /* MD5 this result and the session key, to prove that
1565            only a valid client could had produced this */
1566         hmac_md5(a->sess_key, whole_packet_digest, sizeof(whole_packet_digest), digest_final);
1567 }
1568
1569 /*******************************************************************
1570  Calculate the key with which to encode the data payload 
1571  ********************************************************************/
1572
1573 static void schannel_get_sealing_key(struct schannel_auth_struct *a,
1574                                    RPC_AUTH_SCHANNEL_CHK *verf,
1575                                    uchar sealing_key[16]) 
1576 {
1577         static uchar zeros[4];
1578         uchar digest2[16];
1579         uchar sess_kf0[16];
1580         int i;
1581
1582         for (i = 0; i < sizeof(sess_kf0); i++) {
1583                 sess_kf0[i] = a->sess_key[i] ^ 0xf0;
1584         }
1585         
1586         dump_data_pw("sess_kf0:\n", sess_kf0, sizeof(sess_kf0));
1587         
1588         /* MD5 of sess_kf0 and 4 zero bytes */
1589         hmac_md5(sess_kf0, zeros, 0x4, digest2);
1590         dump_data_pw("digest2:\n", digest2, sizeof(digest2));
1591         
1592         /* MD5 of the above result, plus 8 bytes of sequence number */
1593         hmac_md5(digest2, verf->seq_num, sizeof(verf->seq_num), sealing_key);
1594         dump_data_pw("sealing_key:\n", sealing_key, 16);
1595 }
1596
1597 /*******************************************************************
1598  Encode or Decode the sequence number (which is symmetric)
1599  ********************************************************************/
1600
1601 static void schannel_deal_with_seq_num(struct schannel_auth_struct *a,
1602                                      RPC_AUTH_SCHANNEL_CHK *verf)
1603 {
1604         static uchar zeros[4];
1605         uchar sequence_key[16];
1606         uchar digest1[16];
1607
1608         hmac_md5(a->sess_key, zeros, sizeof(zeros), digest1);
1609         dump_data_pw("(sequence key) digest1:\n", digest1, sizeof(digest1));
1610
1611         hmac_md5(digest1, verf->packet_digest, 8, sequence_key);
1612
1613         dump_data_pw("sequence_key:\n", sequence_key, sizeof(sequence_key));
1614
1615         dump_data_pw("seq_num (before):\n", verf->seq_num, sizeof(verf->seq_num));
1616         SamOEMhash(verf->seq_num, sequence_key, 8);
1617         dump_data_pw("seq_num (after):\n", verf->seq_num, sizeof(verf->seq_num));
1618 }
1619
1620 /*******************************************************************
1621 creates an RPC_AUTH_SCHANNEL_CHK structure.
1622 ********************************************************************/
1623
1624 static BOOL init_rpc_auth_schannel_chk(RPC_AUTH_SCHANNEL_CHK * chk,
1625                               const uchar sig[8],
1626                               const uchar packet_digest[8],
1627                               const uchar seq_num[8], const uchar confounder[8])
1628 {
1629         if (chk == NULL)
1630                 return False;
1631
1632         memcpy(chk->sig, sig, sizeof(chk->sig));
1633         memcpy(chk->packet_digest, packet_digest, sizeof(chk->packet_digest));
1634         memcpy(chk->seq_num, seq_num, sizeof(chk->seq_num));
1635         memcpy(chk->confounder, confounder, sizeof(chk->confounder));
1636
1637         return True;
1638 }
1639
1640 /*******************************************************************
1641  Encode a blob of data using the schannel alogrithm, also produceing
1642  a checksum over the original data.  We currently only support
1643  signing and sealing togeather - the signing-only code is close, but not
1644  quite compatible with what MS does.
1645  ********************************************************************/
1646
1647 void schannel_encode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1648                    enum schannel_direction direction,
1649                    RPC_AUTH_SCHANNEL_CHK * verf,
1650                    char *data, size_t data_len)
1651 {
1652         uchar digest_final[16];
1653         uchar confounder[8];
1654         uchar seq_num[8];
1655         static const uchar nullbytes[8] = { 0, };
1656
1657         static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1658         static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1659         const uchar *schannel_sig = NULL;
1660
1661         DEBUG(10,("SCHANNEL: schannel_encode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1662         
1663         if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1664                 schannel_sig = schannel_seal_sig;
1665         } else {
1666                 schannel_sig = schannel_sign_sig;
1667         }
1668
1669         /* fill the 'confounder' with random data */
1670         generate_random_buffer(confounder, sizeof(confounder));
1671
1672         dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1673
1674         RSIVAL(seq_num, 0, a->seq_num);
1675
1676         switch (direction) {
1677         case SENDER_IS_INITIATOR:
1678                 SIVAL(seq_num, 4, 0x80);
1679                 break;
1680         case SENDER_IS_ACCEPTOR:
1681                 SIVAL(seq_num, 4, 0x0);
1682                 break;
1683         }
1684
1685         dump_data_pw("verf->seq_num:\n", seq_num, sizeof(verf->seq_num));
1686
1687         init_rpc_auth_schannel_chk(verf, schannel_sig, nullbytes,
1688                                  seq_num, confounder);
1689                                 
1690         /* produce a digest of the packet to prove it's legit (before we seal it) */
1691         schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1692         memcpy(verf->packet_digest, digest_final, sizeof(verf->packet_digest));
1693
1694         if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1695                 uchar sealing_key[16];
1696
1697                 /* get the key to encode the data with */
1698                 schannel_get_sealing_key(a, verf, sealing_key);
1699
1700                 /* encode the verification data */
1701                 dump_data_pw("verf->confounder:\n", verf->confounder, sizeof(verf->confounder));
1702                 SamOEMhash(verf->confounder, sealing_key, 8);
1703
1704                 dump_data_pw("verf->confounder_enc:\n", verf->confounder, sizeof(verf->confounder));
1705                 
1706                 /* encode the packet payload */
1707                 dump_data_pw("data:\n", (const unsigned char *)data, data_len);
1708                 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1709                 dump_data_pw("data_enc:\n", (const unsigned char *)data, data_len);
1710         }
1711
1712         /* encode the sequence number (key based on packet digest) */
1713         /* needs to be done after the sealing, as the original version 
1714            is used in the sealing stuff... */
1715         schannel_deal_with_seq_num(a, verf);
1716
1717         return;
1718 }
1719
1720 /*******************************************************************
1721  Decode a blob of data using the schannel alogrithm, also verifiying
1722  a checksum over the original data.  We currently can verify signed messages,
1723  as well as decode sealed messages
1724  ********************************************************************/
1725
1726 BOOL schannel_decode(struct schannel_auth_struct *a, enum pipe_auth_level auth_level,
1727                    enum schannel_direction direction, 
1728                    RPC_AUTH_SCHANNEL_CHK * verf, char *data, size_t data_len)
1729 {
1730         uchar digest_final[16];
1731
1732         static const uchar schannel_seal_sig[8] = SCHANNEL_SEAL_SIGNATURE;
1733         static const uchar schannel_sign_sig[8] = SCHANNEL_SIGN_SIGNATURE;
1734         const uchar *schannel_sig = NULL;
1735
1736         uchar seq_num[8];
1737
1738         DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1739         
1740         if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1741                 schannel_sig = schannel_seal_sig;
1742         } else {
1743                 schannel_sig = schannel_sign_sig;
1744         }
1745
1746         /* Create the expected sequence number for comparison */
1747         RSIVAL(seq_num, 0, a->seq_num);
1748
1749         switch (direction) {
1750         case SENDER_IS_INITIATOR:
1751                 SIVAL(seq_num, 4, 0x80);
1752                 break;
1753         case SENDER_IS_ACCEPTOR:
1754                 SIVAL(seq_num, 4, 0x0);
1755                 break;
1756         }
1757
1758         DEBUG(10,("SCHANNEL: schannel_decode seq_num=%d data_len=%lu\n", a->seq_num, (unsigned long)data_len));
1759         dump_data_pw("a->sess_key:\n", a->sess_key, sizeof(a->sess_key));
1760
1761         dump_data_pw("seq_num:\n", seq_num, sizeof(seq_num));
1762
1763         /* extract the sequence number (key based on supplied packet digest) */
1764         /* needs to be done before the sealing, as the original version 
1765            is used in the sealing stuff... */
1766         schannel_deal_with_seq_num(a, verf);
1767
1768         if (memcmp(verf->seq_num, seq_num, sizeof(seq_num))) {
1769                 /* don't even bother with the below if the sequence number is out */
1770                 /* The sequence number is MD5'ed with a key based on the whole-packet
1771                    digest, as supplied by the client.  We check that it's a valid 
1772                    checksum after the decode, below
1773                 */
1774                 DEBUG(2, ("schannel_decode: FAILED: packet sequence number:\n"));
1775                 dump_data(2, (const uint8 *)verf->seq_num, sizeof(verf->seq_num));
1776                 DEBUG(2, ("should be:\n"));
1777                 dump_data(2, (const uint8 *)seq_num, sizeof(seq_num));
1778
1779                 return False;
1780         }
1781
1782         if (memcmp(verf->sig, schannel_sig, sizeof(verf->sig))) {
1783                 /* Validate that the other end sent the expected header */
1784                 DEBUG(2, ("schannel_decode: FAILED: packet header:\n"));
1785                 dump_data(2, (const uint8 *)verf->sig, sizeof(verf->sig));
1786                 DEBUG(2, ("should be:\n"));
1787                 dump_data(2, (const uint8 *)schannel_sig, sizeof(schannel_sig));
1788                 return False;
1789         }
1790
1791         if (auth_level == PIPE_AUTH_LEVEL_PRIVACY) {
1792                 uchar sealing_key[16];
1793                 
1794                 /* get the key to extract the data with */
1795                 schannel_get_sealing_key(a, verf, sealing_key);
1796
1797                 /* extract the verification data */
1798                 dump_data_pw("verf->confounder:\n", verf->confounder, 
1799                              sizeof(verf->confounder));
1800                 SamOEMhash(verf->confounder, sealing_key, 8);
1801
1802                 dump_data_pw("verf->confounder_dec:\n", verf->confounder, 
1803                              sizeof(verf->confounder));
1804                 
1805                 /* extract the packet payload */
1806                 dump_data_pw("data   :\n", (const unsigned char *)data, data_len);
1807                 SamOEMhash((unsigned char *)data, sealing_key, data_len);
1808                 dump_data_pw("datadec:\n", (const unsigned char *)data, data_len);      
1809         }
1810
1811         /* digest includes 'data' after unsealing */
1812         schannel_digest(a, auth_level, verf, data, data_len, digest_final);
1813
1814         dump_data_pw("Calculated digest:\n", digest_final, 
1815                      sizeof(digest_final));
1816         dump_data_pw("verf->packet_digest:\n", verf->packet_digest, 
1817                      sizeof(verf->packet_digest));
1818         
1819         /* compare - if the client got the same result as us, then
1820            it must know the session key */
1821         return (memcmp(digest_final, verf->packet_digest, 
1822                        sizeof(verf->packet_digest)) == 0);
1823 }
1824
1825 /*******************************************************************
1826 creates a new prs_struct containing a DATA_BLOB
1827 ********************************************************************/
1828 BOOL prs_init_data_blob(prs_struct *prs, DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
1829 {
1830         if (!prs_init( prs, RPC_MAX_PDU_FRAG_LEN, mem_ctx, MARSHALL ))
1831                 return False;
1832
1833
1834         if (!prs_copy_data_in(prs, (char *)blob->data, blob->length))
1835                 return False;
1836
1837         return True;
1838 }
1839
1840 /*******************************************************************
1841 return the contents of a prs_struct in a DATA_BLOB
1842 ********************************************************************/
1843 BOOL prs_data_blob(prs_struct *prs, DATA_BLOB *blob, TALLOC_CTX *mem_ctx)
1844 {
1845         blob->length = prs_data_size(prs);
1846         blob->data = (uint8 *)TALLOC_ZERO_SIZE(mem_ctx, blob->length);
1847         
1848         /* set the pointer at the end of the buffer */
1849         prs_set_offset( prs, prs_data_size(prs) );
1850
1851         if (!prs_copy_all_data_out((char *)blob->data, prs))
1852                 return False;
1853         
1854         return True;
1855 }