r23792: convert Samba4 to GPLv3
[samba.git] / source / libcli / raw / rawreadwrite.c
1 /* 
2    Unix SMB/CIFS implementation.
3    client file read/write routines
4    Copyright (C) Andrew Tridgell 1994-1998
5    Copyright (C) James Myers 2003
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 3 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, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "includes.h"
22 #include "libcli/raw/libcliraw.h"
23
24 #define SETUP_REQUEST(cmd, wct, buflen) do { \
25         req = smbcli_request_setup(tree, cmd, wct, buflen); \
26         if (!req) return NULL; \
27 } while (0)
28
29 /****************************************************************************
30  low level read operation (async send)
31 ****************************************************************************/
32 struct smbcli_request *smb_raw_read_send(struct smbcli_tree *tree, union smb_read *parms)
33 {
34         BOOL bigoffset = False;
35         struct smbcli_request *req = NULL; 
36
37         switch (parms->generic.level) {
38         case RAW_READ_READBRAW:
39                 if (tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES) {
40                         bigoffset = True;
41                 }
42                 SETUP_REQUEST(SMBreadbraw, bigoffset? 10:8, 0);
43                 SSVAL(req->out.vwv, VWV(0), parms->readbraw.in.file.fnum);
44                 SIVAL(req->out.vwv, VWV(1), parms->readbraw.in.offset);
45                 SSVAL(req->out.vwv, VWV(3), parms->readbraw.in.maxcnt);
46                 SSVAL(req->out.vwv, VWV(4), parms->readbraw.in.mincnt);
47                 SIVAL(req->out.vwv, VWV(5), parms->readbraw.in.timeout);
48                 SSVAL(req->out.vwv, VWV(7), 0); /* reserved */
49                 if (bigoffset) {
50                         SIVAL(req->out.vwv, VWV(8),parms->readbraw.in.offset>>32);
51                 }
52                 break;
53
54         case RAW_READ_LOCKREAD:
55                 SETUP_REQUEST(SMBlockread, 5, 0);
56                 SSVAL(req->out.vwv, VWV(0), parms->lockread.in.file.fnum);
57                 SSVAL(req->out.vwv, VWV(1), parms->lockread.in.count);
58                 SIVAL(req->out.vwv, VWV(2), parms->lockread.in.offset);
59                 SSVAL(req->out.vwv, VWV(4), parms->lockread.in.remaining);
60                 break;
61
62         case RAW_READ_READ:
63                 SETUP_REQUEST(SMBread, 5, 0);
64                 SSVAL(req->out.vwv, VWV(0), parms->read.in.file.fnum);
65                 SSVAL(req->out.vwv, VWV(1), parms->read.in.count);
66                 SIVAL(req->out.vwv, VWV(2), parms->read.in.offset);
67                 SSVAL(req->out.vwv, VWV(4), parms->read.in.remaining);
68                 break;
69
70         case RAW_READ_READX:
71                 if (tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES) {
72                         bigoffset = True;
73                 }
74                 SETUP_REQUEST(SMBreadX, bigoffset ? 12 : 10, 0);
75                 SSVAL(req->out.vwv, VWV(0), SMB_CHAIN_NONE);
76                 SSVAL(req->out.vwv, VWV(1), 0);
77                 SSVAL(req->out.vwv, VWV(2), parms->readx.in.file.fnum);
78                 SIVAL(req->out.vwv, VWV(3), parms->readx.in.offset);
79                 SSVAL(req->out.vwv, VWV(5), parms->readx.in.maxcnt & 0xFFFF);
80                 SSVAL(req->out.vwv, VWV(6), parms->readx.in.mincnt);
81                 SIVAL(req->out.vwv, VWV(7), parms->readx.in.maxcnt >> 16);
82                 SSVAL(req->out.vwv, VWV(9), parms->readx.in.remaining);
83                 /*
84                  * TODO: give an error when the offset is 64 bit
85                  *       and the server doesn't support it
86                  */
87                 if (bigoffset) {
88                         SIVAL(req->out.vwv, VWV(10),parms->readx.in.offset>>32);
89                 }
90                 if (parms->readx.in.read_for_execute) {
91                         uint16_t flags2 = SVAL(req->out.hdr, HDR_FLG2);
92                         flags2 |= FLAGS2_READ_PERMIT_EXECUTE;
93                         SSVAL(req->out.hdr, HDR_FLG2, flags2);
94                 }
95                 break;
96
97         case RAW_READ_SMB2:
98                 return NULL;
99         }
100
101         if (!smbcli_request_send(req)) {
102                 smbcli_request_destroy(req);
103                 return NULL;
104         }
105
106         /* the transport layer needs to know that a readbraw is pending
107            and handle receives a little differently */
108         if (parms->generic.level == RAW_READ_READBRAW) {
109                 tree->session->transport->readbraw_pending = 1;
110         }
111
112         return req;
113 }
114
115 /****************************************************************************
116  low level read operation (async recv)
117 ****************************************************************************/
118 NTSTATUS smb_raw_read_recv(struct smbcli_request *req, union smb_read *parms)
119 {
120         if (!smbcli_request_receive(req) ||
121             smbcli_request_is_error(req)) {
122                 goto failed;
123         }
124
125         switch (parms->generic.level) {
126         case RAW_READ_READBRAW:
127                 parms->readbraw.out.nread = req->in.size - NBT_HDR_SIZE;
128                 if (parms->readbraw.out.nread > 
129                     MAX(parms->readx.in.mincnt, parms->readx.in.maxcnt)) {
130                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
131                         goto failed;
132                 }
133                 memcpy(parms->readbraw.out.data, req->in.buffer + NBT_HDR_SIZE, parms->readbraw.out.nread);
134                 break;
135                 
136         case RAW_READ_LOCKREAD:
137                 SMBCLI_CHECK_WCT(req, 5);
138                 parms->lockread.out.nread = SVAL(req->in.vwv, VWV(0));
139                 if (parms->lockread.out.nread > parms->lockread.in.count ||
140                     !smbcli_raw_pull_data(req, req->in.data+3, 
141                                        parms->lockread.out.nread, parms->lockread.out.data)) {
142                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
143                 }
144                 break;
145
146         case RAW_READ_READ:
147                 /* there are 4 reserved words in the reply */
148                 SMBCLI_CHECK_WCT(req, 5);
149                 parms->read.out.nread = SVAL(req->in.vwv, VWV(0));
150                 if (parms->read.out.nread > parms->read.in.count ||
151                     !smbcli_raw_pull_data(req, req->in.data+3, 
152                                        parms->read.out.nread, parms->read.out.data)) {
153                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
154                 }
155                 break;
156
157         case RAW_READ_READX:
158                 /* there are 5 reserved words in the reply */
159                 SMBCLI_CHECK_WCT(req, 12);
160                 parms->readx.out.remaining       = SVAL(req->in.vwv, VWV(2));
161                 parms->readx.out.compaction_mode = SVAL(req->in.vwv, VWV(3));
162                 parms->readx.out.nread = SVAL(req->in.vwv, VWV(5));
163
164                 /* handle oversize replies for non-chained readx replies with
165                    CAP_LARGE_READX. The snia spec has must to answer for. */
166                 if ((req->tree->session->transport->negotiate.capabilities & CAP_LARGE_READX)
167                     && CVAL(req->in.vwv, VWV(0)) == SMB_CHAIN_NONE &&
168                     req->in.size >= 0x10000) {
169                         parms->readx.out.nread += (SVAL(req->in.vwv, VWV(7)) << 16);
170                         if (req->in.hdr + SVAL(req->in.vwv, VWV(6)) +
171                             parms->readx.out.nread <= 
172                             req->in.buffer + req->in.size) {
173                                 req->in.data_size += (SVAL(req->in.vwv, VWV(7)) << 16);
174                         }
175                 }
176
177                 if (parms->readx.out.nread > MAX(parms->readx.in.mincnt, parms->readx.in.maxcnt) ||
178                     !smbcli_raw_pull_data(req, req->in.hdr + SVAL(req->in.vwv, VWV(6)), 
179                                        parms->readx.out.nread, 
180                                        parms->readx.out.data)) {
181                         req->status = NT_STATUS_BUFFER_TOO_SMALL;
182                 }
183                 break;
184
185         case RAW_READ_SMB2:
186                 req->status = NT_STATUS_INTERNAL_ERROR;
187                 break;
188         }
189
190 failed:
191         return smbcli_request_destroy(req);
192 }
193
194 /****************************************************************************
195  low level read operation (sync interface)
196 ****************************************************************************/
197 NTSTATUS smb_raw_read(struct smbcli_tree *tree, union smb_read *parms)
198 {
199         struct smbcli_request *req = smb_raw_read_send(tree, parms);
200         return smb_raw_read_recv(req, parms);
201 }
202
203
204 /****************************************************************************
205  raw write interface (async send)
206 ****************************************************************************/
207 struct smbcli_request *smb_raw_write_send(struct smbcli_tree *tree, union smb_write *parms)
208 {
209         BOOL bigoffset = False;
210         struct smbcli_request *req = NULL; 
211
212         switch (parms->generic.level) {
213         case RAW_WRITE_WRITEUNLOCK:
214                 SETUP_REQUEST(SMBwriteunlock, 5, 3 + parms->writeunlock.in.count);
215                 SSVAL(req->out.vwv, VWV(0), parms->writeunlock.in.file.fnum);
216                 SSVAL(req->out.vwv, VWV(1), parms->writeunlock.in.count);
217                 SIVAL(req->out.vwv, VWV(2), parms->writeunlock.in.offset);
218                 SSVAL(req->out.vwv, VWV(4), parms->writeunlock.in.remaining);
219                 SCVAL(req->out.data, 0, SMB_DATA_BLOCK);
220                 SSVAL(req->out.data, 1, parms->writeunlock.in.count);
221                 if (parms->writeunlock.in.count > 0) {
222                         memcpy(req->out.data+3, parms->writeunlock.in.data, 
223                                parms->writeunlock.in.count);
224                 }
225                 break;
226
227         case RAW_WRITE_WRITE:
228                 SETUP_REQUEST(SMBwrite, 5,  3 + parms->write.in.count);
229                 SSVAL(req->out.vwv, VWV(0), parms->write.in.file.fnum);
230                 SSVAL(req->out.vwv, VWV(1), parms->write.in.count);
231                 SIVAL(req->out.vwv, VWV(2), parms->write.in.offset);
232                 SSVAL(req->out.vwv, VWV(4), parms->write.in.remaining);
233                 SCVAL(req->out.data, 0, SMB_DATA_BLOCK);
234                 SSVAL(req->out.data, 1, parms->write.in.count);
235                 if (parms->write.in.count > 0) {
236                         memcpy(req->out.data+3, parms->write.in.data, parms->write.in.count);
237                 }
238                 break;
239
240         case RAW_WRITE_WRITECLOSE:
241                 SETUP_REQUEST(SMBwriteclose, 6, 1 + parms->writeclose.in.count);
242                 SSVAL(req->out.vwv, VWV(0), parms->writeclose.in.file.fnum);
243                 SSVAL(req->out.vwv, VWV(1), parms->writeclose.in.count);
244                 SIVAL(req->out.vwv, VWV(2), parms->writeclose.in.offset);
245                 raw_push_dos_date3(tree->session->transport,
246                                   req->out.vwv, VWV(4), parms->writeclose.in.mtime);
247                 SCVAL(req->out.data, 0, 0);
248                 if (parms->writeclose.in.count > 0) {
249                         memcpy(req->out.data+1, parms->writeclose.in.data, 
250                                parms->writeclose.in.count);
251                 }
252                 break;
253
254         case RAW_WRITE_WRITEX:
255                 if (tree->session->transport->negotiate.capabilities & CAP_LARGE_FILES) {
256                         bigoffset = True;
257                 }
258                 SETUP_REQUEST(SMBwriteX, bigoffset ? 14 : 12, parms->writex.in.count);
259                 SSVAL(req->out.vwv, VWV(0), SMB_CHAIN_NONE);
260                 SSVAL(req->out.vwv, VWV(1), 0);
261                 SSVAL(req->out.vwv, VWV(2), parms->writex.in.file.fnum);
262                 SIVAL(req->out.vwv, VWV(3), parms->writex.in.offset);
263                 SIVAL(req->out.vwv, VWV(5), 0); /* reserved */
264                 SSVAL(req->out.vwv, VWV(7), parms->writex.in.wmode);
265                 SSVAL(req->out.vwv, VWV(8), parms->writex.in.remaining);
266                 SSVAL(req->out.vwv, VWV(9), parms->writex.in.count>>16);
267                 SSVAL(req->out.vwv, VWV(10), parms->writex.in.count);
268                 SSVAL(req->out.vwv, VWV(11), PTR_DIFF(req->out.data, req->out.hdr));
269                 if (bigoffset) {
270                         SIVAL(req->out.vwv,VWV(12),parms->writex.in.offset>>32);
271                 }
272                 if (parms->writex.in.count > 0) {
273                         memcpy(req->out.data, parms->writex.in.data, parms->writex.in.count);
274                 }
275                 break;
276
277         case RAW_WRITE_SPLWRITE:
278                 SETUP_REQUEST(SMBsplwr, 1, parms->splwrite.in.count);
279                 SSVAL(req->out.vwv, VWV(0), parms->splwrite.in.file.fnum);
280                 if (parms->splwrite.in.count > 0) {
281                         memcpy(req->out.data, parms->splwrite.in.data, parms->splwrite.in.count);
282                 }
283                 break;
284
285         case RAW_WRITE_SMB2:
286                 return NULL;
287         }
288
289         if (!smbcli_request_send(req)) {
290                 smbcli_request_destroy(req);
291                 return NULL;
292         }
293
294         return req;
295 }
296
297
298 /****************************************************************************
299  raw write interface (async recv)
300 ****************************************************************************/
301 NTSTATUS smb_raw_write_recv(struct smbcli_request *req, union smb_write *parms)
302 {
303         if (!smbcli_request_receive(req) ||
304             smbcli_request_is_error(req)) {
305                 goto failed;
306         }
307
308         switch (parms->generic.level) {
309         case RAW_WRITE_WRITEUNLOCK:
310                 SMBCLI_CHECK_WCT(req, 1);               
311                 parms->writeunlock.out.nwritten = SVAL(req->in.vwv, VWV(0));
312                 break;
313         case RAW_WRITE_WRITE:
314                 SMBCLI_CHECK_WCT(req, 1);
315                 parms->write.out.nwritten = SVAL(req->in.vwv, VWV(0));
316                 break;
317         case RAW_WRITE_WRITECLOSE:
318                 SMBCLI_CHECK_WCT(req, 1);
319                 parms->writeclose.out.nwritten = SVAL(req->in.vwv, VWV(0));
320                 break;
321         case RAW_WRITE_WRITEX:
322                 SMBCLI_CHECK_WCT(req, 6);
323                 parms->writex.out.nwritten  = SVAL(req->in.vwv, VWV(2));
324                 parms->writex.out.nwritten += (CVAL(req->in.vwv, VWV(4)) << 16);
325                 parms->writex.out.remaining = SVAL(req->in.vwv, VWV(3));
326                 break;
327         case RAW_WRITE_SPLWRITE:
328                 break;
329         case RAW_WRITE_SMB2:
330                 req->status = NT_STATUS_INTERNAL_ERROR;
331                 break;
332         }
333
334 failed:
335         return smbcli_request_destroy(req);
336 }
337
338 /****************************************************************************
339  raw write interface (sync interface)
340 ****************************************************************************/
341 NTSTATUS smb_raw_write(struct smbcli_tree *tree, union smb_write *parms)
342 {
343         struct smbcli_request *req = smb_raw_write_send(tree, parms);
344         return smb_raw_write_recv(req, parms);
345 }