2 * Unix SMB/CIFS implementation.
3 * RPC Pipe client / server routines
5 * Copyright (C) Andrew Tridgell 1992-2000,
6 * Copyright (C) Luke Kenneth Casson Leighton 1996-2000,
7 * Copyright (C) Jean François Micouleau 1998-2000,
8 * Copyright (C) Gerald Carter 2000-2005,
9 * Copyright (C) Tim Potter 2001-2002.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, see <http://www.gnu.org/licenses/>.
28 #define DBGC_CLASS DBGC_RPC_PARSE
30 /**********************************************************************
31 Initialize a new spoolss buff for use by a client rpc
32 **********************************************************************/
33 void rpcbuf_init(RPC_BUFFER *buffer, uint32 size, TALLOC_CTX *ctx)
36 buffer->string_at_end = size;
37 prs_init(&buffer->prs, size, ctx, MARSHALL);
38 buffer->struct_start = prs_offset(&buffer->prs);
41 /*******************************************************************
42 Read/write a RPC_BUFFER struct.
43 ********************************************************************/
45 bool prs_rpcbuffer(const char *desc, prs_struct *ps, int depth, RPC_BUFFER *buffer)
47 prs_debug(ps, depth, desc, "prs_rpcbuffer");
51 if (UNMARSHALLING(ps)) {
53 buffer->string_at_end=0;
55 if (!prs_uint32("size", ps, depth, &buffer->size))
59 * JRA. I'm not sure if the data in here is in big-endian format if
60 * the client is big-endian. Leave as default (little endian) for now.
63 if (!prs_init(&buffer->prs, buffer->size, prs_get_mem_context(ps), UNMARSHALL))
66 if (!prs_append_some_prs_data(&buffer->prs, ps, prs_offset(ps), buffer->size))
69 if (!prs_set_offset(&buffer->prs, 0))
72 if (!prs_set_offset(ps, buffer->size+prs_offset(ps)))
75 buffer->string_at_end=buffer->size;
82 if (!prs_uint32("size", ps, depth, &buffer->size))
85 if (!prs_append_some_prs_data(ps, &buffer->prs, 0, buffer->size))
91 /* We have finished with the data in buffer->prs - free it. */
92 prs_mem_free(&buffer->prs);
98 /*******************************************************************
99 Read/write an RPC_BUFFER* struct.(allocate memory if unmarshalling)
100 ********************************************************************/
102 bool prs_rpcbuffer_p(const char *desc, prs_struct *ps, int depth, RPC_BUFFER **buffer)
106 /* caputure the pointer value to stream */
108 data_p = *buffer ? 0xf000baaa : 0;
110 if ( !prs_uint32("ptr", ps, depth, &data_p ))
113 /* we're done if there is no data */
118 if ( UNMARSHALLING(ps) ) {
119 if ( !(*buffer = PRS_ALLOC_MEM(ps, RPC_BUFFER, 1)) )
122 /* Marshalling case. - coverity paranoia - should already be ok if data_p != 0 */
128 return prs_rpcbuffer( desc, ps, depth, *buffer);
131 /****************************************************************************
132 Allocate more memory for a RPC_BUFFER.
133 ****************************************************************************/
135 bool rpcbuf_alloc_size(RPC_BUFFER *buffer, uint32 buffer_size)
141 /* if we don't need anything. don't do anything */
143 if ( buffer_size == 0x0 )
152 /* damn, I'm doing the reverse operation of prs_grow() :) */
153 if (buffer_size < prs_data_size(ps))
156 extra_space = buffer_size - prs_data_size(ps);
159 * save the offset and move to the end of the buffer
160 * prs_grow() checks the extra_space against the offset
162 old_offset=prs_offset(ps);
163 prs_set_offset(ps, prs_data_size(ps));
165 if (!prs_grow(ps, extra_space))
168 prs_set_offset(ps, old_offset);
170 buffer->string_at_end=prs_data_size(ps);
175 /*******************************************************************
176 move a BUFFER from the query to the reply.
177 As the data pointers in RPC_BUFFER are malloc'ed, not talloc'ed,
178 this is ok. This is an OPTIMIZATION and is not strictly neccessary.
179 Clears the memory to zero also.
180 ********************************************************************/
182 void rpcbuf_move(RPC_BUFFER *src, RPC_BUFFER **dest)
189 prs_switch_type( &src->prs, MARSHALL );
191 if ( !prs_set_offset(&src->prs, 0) )
194 prs_force_dynamic( &src->prs );
195 prs_mem_clear( &src->prs );
200 /*******************************************************************
201 Get the size of a BUFFER struct.
202 ********************************************************************/
204 uint32 rpcbuf_get_size(RPC_BUFFER *buffer)
206 return (buffer->size);
210 /*******************************************************************
211 * write a UNICODE string and its relative pointer.
212 * used by all the RPC structs passing a buffer
214 * As I'm a nice guy, I'm forcing myself to explain this code.
215 * MS did a good job in the overall spoolss code except in some
216 * functions where they are passing the API buffer directly in the
217 * RPC request/reply. That's to maintain compatiility at the API level.
218 * They could have done it the good way the first time.
220 * So what happen is: the strings are written at the buffer's end,
221 * in the reverse order of the original structure. Some pointers to
222 * the strings are also in the buffer. Those are relative to the
225 * If you don't understand or want to change that function,
226 * first get in touch with me: jfm@samba.org
228 ********************************************************************/
230 bool smb_io_relstr(const char *desc, RPC_BUFFER *buffer, int depth, UNISTR *string)
232 prs_struct *ps=&buffer->prs;
234 if (MARSHALLING(ps)) {
235 uint32 struct_offset = prs_offset(ps);
236 uint32 relative_offset;
238 buffer->string_at_end -= (size_of_relative_string(string) - 4);
239 if(!prs_set_offset(ps, buffer->string_at_end))
243 * Win2k does not align strings in a buffer
244 * Tested against WinNT 4.0 SP 6a & 2k SP2 --jerry
249 buffer->string_at_end = prs_offset(ps);
251 /* write the string */
252 if (!smb_io_unistr(desc, string, ps, depth))
255 if(!prs_set_offset(ps, struct_offset))
258 relative_offset=buffer->string_at_end - buffer->struct_start;
259 /* write its offset */
260 if (!prs_uint32("offset", ps, depth, &relative_offset))
266 /* read the offset */
267 if (!prs_uint32("offset", ps, depth, &(buffer->string_at_end)))
270 if (buffer->string_at_end == 0)
273 old_offset = prs_offset(ps);
274 if(!prs_set_offset(ps, buffer->string_at_end+buffer->struct_start))
277 /* read the string */
278 if (!smb_io_unistr(desc, string, ps, depth))
281 if(!prs_set_offset(ps, old_offset))
287 /*******************************************************************
288 * write a array of UNICODE strings and its relative pointer.
289 * used by 2 RPC structs
290 ********************************************************************/
292 bool smb_io_relarraystr(const char *desc, RPC_BUFFER *buffer, int depth, uint16 **string)
296 prs_struct *ps=&buffer->prs;
298 if (MARSHALLING(ps)) {
299 uint32 struct_offset = prs_offset(ps);
300 uint32 relative_offset;
307 /* first write the last 0 */
308 buffer->string_at_end -= 2;
309 if(!prs_set_offset(ps, buffer->string_at_end))
312 if(!prs_uint16("leading zero", ps, depth, &zero))
315 while (p && (*p!=0)) {
319 /* Yes this should be malloc not talloc. Don't change. */
321 chaine.buffer = (uint16 *)
322 SMB_MALLOC((q-p+1)*sizeof(uint16));
323 if (chaine.buffer == NULL)
326 memcpy(chaine.buffer, p, (q-p+1)*sizeof(uint16));
328 buffer->string_at_end -= (q-p+1)*sizeof(uint16);
330 if(!prs_set_offset(ps, buffer->string_at_end)) {
331 SAFE_FREE(chaine.buffer);
335 /* write the string */
336 if (!smb_io_unistr(desc, &chaine, ps, depth)) {
337 SAFE_FREE(chaine.buffer);
343 SAFE_FREE(chaine.buffer);
346 if(!prs_set_offset(ps, struct_offset))
349 relative_offset=buffer->string_at_end - buffer->struct_start;
350 /* write its offset */
351 if (!prs_uint32("offset", ps, depth, &relative_offset))
359 uint16 *chaine2=NULL;
362 size_t realloc_size = 0;
366 /* read the offset */
367 if (!prs_uint32("offset", ps, depth, &buffer->string_at_end))
370 old_offset = prs_offset(ps);
371 if(!prs_set_offset(ps, buffer->string_at_end + buffer->struct_start))
375 if (!smb_io_unistr(desc, &chaine, ps, depth))
378 l_chaine=str_len_uni(&chaine);
380 /* we're going to add two more bytes here in case this
381 is the last string in the array and we need to add
382 an extra NULL for termination */
384 realloc_size = (l_chaine2+l_chaine+2)*sizeof(uint16);
386 /* Yes this should be realloc - it's freed below. JRA */
388 if((chaine2=(uint16 *)SMB_REALLOC(chaine2, realloc_size)) == NULL) {
391 memcpy(chaine2+l_chaine2, chaine.buffer, (l_chaine+1)*sizeof(uint16));
392 l_chaine2+=l_chaine+1;
395 } while(l_chaine!=0);
397 /* the end should be bould NULL terminated so add
398 the second one here */
401 chaine2[l_chaine2] = '\0';
402 *string=(uint16 *)TALLOC_MEMDUP(prs_get_mem_context(ps),chaine2,realloc_size);
409 if(!prs_set_offset(ps, old_offset))
415 /*******************************************************************
416 Parse a DEVMODE structure and its relative pointer.
417 ********************************************************************/
419 bool smb_io_relsecdesc(const char *desc, RPC_BUFFER *buffer, int depth, SEC_DESC **secdesc)
421 prs_struct *ps= &buffer->prs;
423 prs_debug(ps, depth, desc, "smb_io_relsecdesc");
426 if (MARSHALLING(ps)) {
427 uint32 struct_offset = prs_offset(ps);
428 uint32 relative_offset;
432 if (!prs_uint32("offset", ps, depth, &relative_offset))
437 if (*secdesc != NULL) {
438 buffer->string_at_end -= sec_desc_size(*secdesc);
440 if(!prs_set_offset(ps, buffer->string_at_end))
442 /* write the secdesc */
443 if (!sec_io_desc(desc, secdesc, ps, depth))
446 if(!prs_set_offset(ps, struct_offset))
450 relative_offset=buffer->string_at_end - buffer->struct_start;
451 /* write its offset */
453 if (!prs_uint32("offset", ps, depth, &relative_offset))
458 /* read the offset */
459 if (!prs_uint32("offset", ps, depth, &buffer->string_at_end))
462 old_offset = prs_offset(ps);
463 if(!prs_set_offset(ps, buffer->string_at_end + buffer->struct_start))
467 if (!sec_io_desc(desc, secdesc, ps, depth))
470 if(!prs_set_offset(ps, old_offset))
478 /*******************************************************************
479 * return the length of a UNICODE string in number of char, includes:
481 * - the relative pointer size
482 ********************************************************************/
484 uint32 size_of_relative_string(UNISTR *string)
488 size=str_len_uni(string); /* the string length */
489 size=size+1; /* add the trailing zero */
490 size=size*2; /* convert in char */
491 size=size+4; /* add the size of the ptr */
495 * Do not include alignment as Win2k does not align relative
496 * strings within a buffer --jerry
498 /* Ensure size is 4 byte multiple (prs_align is being called...). */
499 /* size += ((4 - (size & 3)) & 3); */