r3419: moved the libcli/raw structures into libcli/raw/libcliraw.h
[bbaumbach/samba-autobuild/.git] / source4 / libcli / raw / rawtrans.c
1 /* 
2    Unix SMB/CIFS implementation.
3    raw trans/trans2/nttrans operations
4
5    Copyright (C) James Myers 2003 <myersjj@samba.org>
6    
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11    
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16    
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
22 #include "includes.h"
23 #include "libcli/raw/libcliraw.h"
24
25
26 /*
27   check out of bounds for incoming data
28 */
29 static BOOL raw_trans_oob(struct smbcli_request *req,
30                           uint_t offset, uint_t count)
31 {
32         char *ptr;
33
34         if (count == 0) {
35                 return False;
36         }
37
38         ptr = req->in.hdr + offset;
39         
40         /* be careful with wraparound! */
41         if (ptr < req->in.data ||
42             ptr >= req->in.data + req->in.data_size ||
43             count > req->in.data_size ||
44             ptr + count > req->in.data + req->in.data_size) {
45                 return True;
46         }
47         return False;   
48 }
49
50 /****************************************************************************
51   receive a SMB trans or trans2 response allocating the necessary memory
52   ****************************************************************************/
53 NTSTATUS smb_raw_trans2_recv(struct smbcli_request *req,
54                              TALLOC_CTX *mem_ctx,
55                              struct smb_trans2 *parms)
56 {
57         int total_data=0;
58         int total_param=0;
59         char *tdata;
60         char *tparam;
61
62         parms->out.data.length = 0;
63         parms->out.data.data = NULL;
64         parms->out.params.length = 0;
65         parms->out.params.data = NULL;
66
67         if (!smbcli_request_receive(req)) {
68                 return smbcli_request_destroy(req);
69         }
70         
71         /*
72          * An NT RPC pipe call can return ERRDOS, ERRmoredata
73          * to a trans call. This is not an error and should not
74          * be treated as such.
75          */
76         if (NT_STATUS_IS_ERR(req->status)) {
77                 return smbcli_request_destroy(req);
78         }
79
80         SMBCLI_CHECK_MIN_WCT(req, 10);
81
82         /* parse out the lengths */
83         total_data = SVAL(req->in.vwv, VWV(1));
84         total_param = SVAL(req->in.vwv, VWV(0));
85
86         /* allocate it */
87         if (total_data != 0) {
88                 tdata = talloc(mem_ctx, total_data);
89                 if (!tdata) {
90                         DEBUG(0,("smb_raw_receive_trans: failed to enlarge data buffer to %d bytes\n", total_data));
91                         req->status = NT_STATUS_NO_MEMORY;
92                         return smbcli_request_destroy(req);
93                 }
94                 parms->out.data.data = tdata;
95         }
96
97         if (total_param != 0) {
98                 tparam = talloc(mem_ctx, total_param);
99                 if (!tparam) {
100                         DEBUG(0,("smb_raw_receive_trans: failed to enlarge param buffer to %d bytes\n", total_param));
101                         req->status = NT_STATUS_NO_MEMORY;
102                         return smbcli_request_destroy(req);
103                 }
104                 parms->out.params.data = tparam;
105         }
106
107         parms->out.setup_count = SVAL(req->in.vwv, VWV(9));
108         SMBCLI_CHECK_WCT(req, 10 + parms->out.setup_count);
109
110         if (parms->out.setup_count > 0) {
111                 int i;
112                 parms->out.setup = talloc(mem_ctx, 2 * parms->out.setup_count);
113                 if (!parms->out.setup) {
114                         req->status = NT_STATUS_NO_MEMORY;
115                         return smbcli_request_destroy(req);
116                 }
117                 for (i=0;i<parms->out.setup_count;i++) {
118                         parms->out.setup[i] = SVAL(req->in.vwv, VWV(10+i));
119                 }
120         }
121
122         while (1)  {
123                 uint16_t param_count, param_ofs, param_disp;
124                 uint16_t data_count, data_ofs, data_disp;
125                 uint16_t total_data2, total_param2;
126
127                 /* parse out the total lengths again - they can shrink! */
128                 total_data2 = SVAL(req->in.vwv, VWV(1));
129                 total_param2 = SVAL(req->in.vwv, VWV(0));
130
131                 if (total_data2 > total_data ||
132                     total_param2 > total_param) {
133                         /* they must *only* shrink */
134                         DEBUG(1,("smb_raw_receive_trans: data/params expanded!\n"));
135                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
136                         return smbcli_request_destroy(req);
137                 }
138
139                 total_data = total_data2;
140                 total_param = total_param2;             
141
142                 /* parse params for this lump */
143                 param_count = SVAL(req->in.vwv, VWV(3));
144                 param_ofs   = SVAL(req->in.vwv, VWV(4));
145                 param_disp  = SVAL(req->in.vwv, VWV(5));
146
147                 data_count = SVAL(req->in.vwv, VWV(6));
148                 data_ofs   = SVAL(req->in.vwv, VWV(7));
149                 data_disp  = SVAL(req->in.vwv, VWV(8));
150
151                 if (data_count + data_disp > total_data ||
152                     param_count + param_disp > total_param) {
153                         DEBUG(1,("smb_raw_receive_trans: Buffer overflow\n"));
154                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
155                         return smbcli_request_destroy(req);
156                 }
157                 
158                 /* check the server isn't being nasty */
159                 if (raw_trans_oob(req, param_ofs, param_count) ||
160                     raw_trans_oob(req, data_ofs, data_count)) {
161                         DEBUG(1,("smb_raw_receive_trans: out of bounds parameters!\n"));
162                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
163                         return smbcli_request_destroy(req);
164                 }
165
166                 if (data_count) {
167                         memcpy(parms->out.data.data + data_disp,
168                                req->in.hdr + data_ofs, 
169                                data_count);
170                 }
171
172                 if (param_count) {
173                         memcpy(parms->out.params.data + param_disp,
174                                req->in.hdr + param_ofs, 
175                                param_count);
176                 }
177
178                 parms->out.data.length += data_count;
179                 parms->out.params.length += param_count;
180
181                 if (total_data <= parms->out.data.length && total_param <= parms->out.params.length)
182                         break;
183         
184                 if (!smbcli_request_receive_more(req)) {
185                         req->status = NT_STATUS_UNSUCCESSFUL;
186                         return smbcli_request_destroy(req);
187                 }
188         }
189
190 failed:
191         return smbcli_request_destroy(req);
192 }
193
194 NTSTATUS smb_raw_trans_recv(struct smbcli_request *req,
195                              TALLOC_CTX *mem_ctx,
196                              struct smb_trans2 *parms)
197 {
198         return smb_raw_trans2_recv(req, mem_ctx, parms);
199 }
200
201 /****************************************************************************
202  trans/trans2 raw async interface - only BLOBs used in this interface.
203  note that this doesn't yet support multi-part requests
204 ****************************************************************************/
205 struct smbcli_request *smb_raw_trans_send_backend(struct smbcli_tree *tree,
206                                                struct smb_trans2 *parms,
207                                                uint8_t command)
208 {
209         int wct = 14 + parms->in.setup_count;
210         struct smbcli_request *req; 
211         char *outdata,*outparam;
212         int i;
213         int padding;
214         size_t namelen = 0;
215
216         if (command == SMBtrans)
217                 padding = 1;
218         else
219                 padding = 3;
220         
221         req = smbcli_request_setup(tree, command, wct, padding);
222         if (!req) {
223                 return NULL;
224         }
225         
226         /* fill in SMB parameters */
227         outparam = req->out.data + padding;
228         outdata = outparam + parms->in.params.length;
229
230         /* make sure we don't leak data via the padding */
231         memset(req->out.data, 0, padding);
232
233         if (command == SMBtrans && parms->in.trans_name) {
234                 namelen = smbcli_req_append_string(req, parms->in.trans_name, 
235                                                 STR_TERMINATE);
236         }
237
238         /* primary request */
239         SSVAL(req->out.vwv,VWV(0),parms->in.params.length);
240         SSVAL(req->out.vwv,VWV(1),parms->in.data.length);
241         SSVAL(req->out.vwv,VWV(2),parms->in.max_param);
242         SSVAL(req->out.vwv,VWV(3),parms->in.max_data);
243         SSVAL(req->out.vwv,VWV(4),parms->in.max_setup);
244         SSVAL(req->out.vwv,VWV(5),parms->in.flags);
245         SIVAL(req->out.vwv,VWV(6),parms->in.timeout);
246         SSVAL(req->out.vwv,VWV(8),0); /* reserved */
247         SSVAL(req->out.vwv,VWV(9),parms->in.params.length);
248         SSVAL(req->out.vwv,VWV(10),PTR_DIFF(outparam,req->out.hdr)+namelen);
249         SSVAL(req->out.vwv,VWV(11),parms->in.data.length);
250         SSVAL(req->out.vwv,VWV(12),PTR_DIFF(outdata,req->out.hdr)+namelen);
251         SSVAL(req->out.vwv,VWV(13),parms->in.setup_count);
252         for (i=0;i<parms->in.setup_count;i++)   {
253                 SSVAL(req->out.vwv,VWV(14)+i*2,parms->in.setup[i]);
254         }
255         if (parms->in.params.data)      {
256                 smbcli_req_append_blob(req, &parms->in.params);
257         }
258         if (parms->in.data.data) {
259                 smbcli_req_append_blob(req, &parms->in.data);
260         }
261
262         if (!smbcli_request_send(req)) {
263                 smbcli_request_destroy(req);
264                 return NULL;
265         }
266         
267         return req;
268 }
269
270 /****************************************************************************
271  trans/trans2 raw async interface - only BLOBs used in this interface.
272 note that this doesn't yet support multi-part requests
273 ****************************************************************************/
274
275 struct smbcli_request *smb_raw_trans_send(struct smbcli_tree *tree,
276                                        struct smb_trans2 *parms)
277 {
278         return smb_raw_trans_send_backend(tree, parms, SMBtrans);
279 }
280
281 struct smbcli_request *smb_raw_trans2_send(struct smbcli_tree *tree,
282                                        struct smb_trans2 *parms)
283 {
284         return smb_raw_trans_send_backend(tree, parms, SMBtrans2);
285 }
286
287 /*
288   trans2 synchronous blob interface
289 */
290 NTSTATUS smb_raw_trans2(struct smbcli_tree *tree,
291                         TALLOC_CTX *mem_ctx,
292                         struct smb_trans2 *parms)
293 {
294         struct smbcli_request *req;
295         req = smb_raw_trans2_send(tree, parms);
296         if (!req) return NT_STATUS_UNSUCCESSFUL;
297         return smb_raw_trans2_recv(req, mem_ctx, parms);
298 }
299
300
301 /*
302   trans synchronous blob interface
303 */
304 NTSTATUS smb_raw_trans(struct smbcli_tree *tree,
305                        TALLOC_CTX *mem_ctx,
306                        struct smb_trans2 *parms)
307 {
308         struct smbcli_request *req;
309         req = smb_raw_trans_send(tree, parms);
310         if (!req) return NT_STATUS_UNSUCCESSFUL;
311         return smb_raw_trans_recv(req, mem_ctx, parms);
312 }
313
314 /****************************************************************************
315   receive a SMB nttrans response allocating the necessary memory
316   ****************************************************************************/
317 NTSTATUS smb_raw_nttrans_recv(struct smbcli_request *req,
318                               TALLOC_CTX *mem_ctx,
319                               struct smb_nttrans *parms)
320 {
321         uint32_t total_data, recvd_data=0;
322         uint32_t total_param, recvd_param=0;
323
324         if (!smbcli_request_receive(req) ||
325             smbcli_request_is_error(req)) {
326                 return smbcli_request_destroy(req);
327         }
328
329         /* sanity check */
330         if (CVAL(req->in.hdr, HDR_COM) != SMBnttrans) {
331                 DEBUG(0,("smb_raw_receive_nttrans: Expected %s response, got command 0x%02x\n",
332                          "SMBnttrans", 
333                          CVAL(req->in.hdr,HDR_COM)));
334                 req->status = NT_STATUS_UNSUCCESSFUL;
335                 return smbcli_request_destroy(req);
336         }
337
338         SMBCLI_CHECK_MIN_WCT(req, 18);
339
340         /* parse out the lengths */
341         total_param = IVAL(req->in.vwv, 3);
342         total_data  = IVAL(req->in.vwv, 7);
343
344         parms->out.data = data_blob_talloc(mem_ctx, NULL, total_data);
345         parms->out.params = data_blob_talloc(mem_ctx, NULL, total_param);
346
347         if (parms->out.data.length != total_data ||
348             parms->out.params.length != total_param) {
349                 req->status = NT_STATUS_NO_MEMORY;
350                 return smbcli_request_destroy(req);
351         }
352
353         parms->out.setup_count = CVAL(req->in.vwv, 35);
354         SMBCLI_CHECK_WCT(req, 18 + parms->out.setup_count);
355
356         if (parms->out.setup_count > 0) {
357                 int i;
358                 parms->out.setup = talloc(mem_ctx, 2 * parms->out.setup_count);
359                 if (!parms->out.setup) {
360                         req->status = NT_STATUS_NO_MEMORY;
361                         return smbcli_request_destroy(req);
362                 }
363                 for (i=0;i<parms->out.setup_count;i++) {
364                         parms->out.setup[i] = SVAL(req->in.vwv, VWV(18+i));
365                 }
366         }
367         
368         while (recvd_data < total_data || 
369                recvd_param < total_param)  {
370                 uint32_t param_count, param_ofs, param_disp;
371                 uint32_t data_count, data_ofs, data_disp;
372                 uint32_t total_data2, total_param2;
373
374                 /* parse out the total lengths again - they can shrink! */
375                 total_param2 = IVAL(req->in.vwv, 3);
376                 total_data2  = IVAL(req->in.vwv, 7);
377
378                 if (total_data2 > total_data ||
379                     total_param2 > total_param) {
380                         /* they must *only* shrink */
381                         DEBUG(1,("smb_raw_receive_nttrans: data/params expanded!\n"));
382                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
383                         return smbcli_request_destroy(req);
384                 }
385
386                 total_data = total_data2;
387                 total_param = total_param2;
388                 parms->out.data.length = total_data;
389                 parms->out.params.length = total_param;
390
391                 /* parse params for this lump */
392                 param_count = IVAL(req->in.vwv, 11);
393                 param_ofs   = IVAL(req->in.vwv, 15);
394                 param_disp  = IVAL(req->in.vwv, 19);
395
396                 data_count = IVAL(req->in.vwv, 23);
397                 data_ofs   = IVAL(req->in.vwv, 27);
398                 data_disp  = IVAL(req->in.vwv, 31);
399
400                 if (data_count + data_disp > total_data ||
401                     param_count + param_disp > total_param) {
402                         DEBUG(1,("smb_raw_receive_nttrans: Buffer overflow\n"));
403                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
404                         return smbcli_request_destroy(req);
405                 }
406                 
407                 /* check the server isn't being nasty */
408                 if (raw_trans_oob(req, param_ofs, param_count) ||
409                     raw_trans_oob(req, data_ofs, data_count)) {
410                         DEBUG(1,("smb_raw_receive_nttrans: out of bounds parameters!\n"));
411                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
412                         return smbcli_request_destroy(req);
413                 }
414
415                 if (data_count) {
416                         memcpy(parms->out.data.data + data_disp,
417                                req->in.hdr + data_ofs, 
418                                data_count);
419                 }
420
421                 if (param_count) {
422                         memcpy(parms->out.params.data + param_disp,
423                                req->in.hdr + param_ofs, 
424                                param_count);
425                 }
426
427                 recvd_param += param_count;
428                 recvd_data += data_count;
429
430                 if (recvd_data >= total_data &&
431                     recvd_param >= total_param) {
432                         break;
433                 }
434                 
435                 if (!smbcli_request_receive(req) ||
436                     smbcli_request_is_error(req)) {
437                         return smbcli_request_destroy(req);
438                 }
439                 
440                 /* sanity check */
441                 if (CVAL(req->in.hdr, HDR_COM) != SMBnttrans) {
442                         DEBUG(0,("smb_raw_receive_nttrans: Expected nttranss, got command 0x%02x\n",
443                                  CVAL(req->in.hdr, HDR_COM)));
444                         req->status = NT_STATUS_UNSUCCESSFUL;
445                         return smbcli_request_destroy(req);
446                 }
447         }
448
449 failed:
450         return smbcli_request_destroy(req);
451 }
452
453
454 /****************************************************************************
455  nttrans raw - only BLOBs used in this interface.
456  at the moment we only handle a single primary request 
457 ****************************************************************************/
458 struct smbcli_request *smb_raw_nttrans_send(struct smbcli_tree *tree,
459                                          struct smb_nttrans *parms)
460 {
461         struct smbcli_request *req; 
462         char *outdata, *outparam;
463         int i;
464         int align = 0;
465
466         /* only align if there are parameters or data */
467         if (parms->in.params.length || parms->in.data.length) {
468                 align = 3;
469         }
470         
471         req = smbcli_request_setup(tree, SMBnttrans, 
472                                 19 + parms->in.setup_count, 
473                                 align +
474                                 parms->in.params.length +
475                                 parms->in.data.length);
476         if (!req) {
477                 return NULL;
478         }
479         
480         /* fill in SMB parameters */
481         outparam = req->out.data + align;
482         outdata = outparam + parms->in.params.length;
483
484         if (align != 0) {
485                 memset(req->out.data, 0, align);
486         }
487
488         SCVAL(req->out.vwv,  0, parms->in.max_setup);
489         SSVAL(req->out.vwv,  1, 0); /* reserved */
490         SIVAL(req->out.vwv,  3, parms->in.params.length);
491         SIVAL(req->out.vwv,  7, parms->in.data.length);
492         SIVAL(req->out.vwv, 11, parms->in.max_param);
493         SIVAL(req->out.vwv, 15, parms->in.max_data);
494         SIVAL(req->out.vwv, 19, parms->in.params.length);
495         SIVAL(req->out.vwv, 23, PTR_DIFF(outparam,req->out.hdr));
496         SIVAL(req->out.vwv, 27, parms->in.data.length);
497         SIVAL(req->out.vwv, 31, PTR_DIFF(outdata,req->out.hdr));
498         SCVAL(req->out.vwv, 35, parms->in.setup_count);
499         SSVAL(req->out.vwv, 36, parms->in.function);
500         for (i=0;i<parms->in.setup_count;i++) {
501                 SSVAL(req->out.vwv,VWV(19+i),parms->in.setup[i]);
502         }
503         if (parms->in.params.length) {
504                 memcpy(outparam, parms->in.params.data, parms->in.params.length);
505         }
506         if (parms->in.data.length) {
507                 memcpy(outparam, parms->in.data.data, parms->in.data.length);
508         }
509
510         if (!smbcli_request_send(req)) {
511                 smbcli_request_destroy(req);
512                 return NULL;
513         }
514
515         return req;
516 }
517
518
519 /****************************************************************************
520   receive a SMB nttrans response allocating the necessary memory
521   ****************************************************************************/
522 NTSTATUS smb_raw_nttrans(struct smbcli_tree *tree,
523                          TALLOC_CTX *mem_ctx,
524                          struct smb_nttrans *parms)
525 {
526         struct smbcli_request *req;
527
528         req = smb_raw_nttrans_send(tree, parms);
529         if (!req) {
530                 return NT_STATUS_UNSUCCESSFUL;
531         }
532
533         return smb_raw_nttrans_recv(req, mem_ctx, parms);
534 }
535
536 /*
537   work out the maximum data size for a trans request while avoiding 
538   multi-part replies
539
540   TODO: we only need to avoid multi-part replies because the
541   multi-part trans receive code is broken.
542 */
543 size_t smb_raw_max_trans_data(struct smbcli_tree *tree, size_t param_size)
544 {
545         return tree->session->transport->options.max_xmit - (70 + param_size);
546 }