2 Unix SMB/CIFS implementation.
3 client transaction calls
4 Copyright (C) Andrew Tridgell 1994-1998
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "libsmb/libsmb.h"
22 #include "../lib/util/tevent_ntstatus.h"
23 #include "async_smb.h"
25 struct trans_recvblob {
27 uint32_t max, total, received;
30 struct cli_trans_state {
31 struct cli_state *cli;
32 struct tevent_context *ev;
35 const char *pipe_name;
36 uint8_t *pipe_name_conv;
37 size_t pipe_name_conv_len;
42 uint8_t num_setup, max_setup;
44 uint32_t num_param, param_sent;
46 uint32_t num_data, data_sent;
50 struct trans_recvblob rparam;
51 struct trans_recvblob rdata;
59 struct tevent_req *primary_subreq;
62 static void cli_trans_cleanup_primary(struct cli_trans_state *state)
64 if (state->primary_subreq) {
65 cli_smb_req_set_mid(state->primary_subreq, 0);
66 cli_smb_req_unset_pending(state->primary_subreq);
67 TALLOC_FREE(state->primary_subreq);
71 static int cli_trans_state_destructor(struct cli_trans_state *state)
73 cli_trans_cleanup_primary(state);
77 static NTSTATUS cli_pull_trans(uint8_t *inbuf,
78 uint8_t wct, uint16_t *vwv,
79 uint16_t num_bytes, uint8_t *bytes,
80 uint8_t smb_cmd, bool expect_first_reply,
81 uint8_t *pnum_setup, uint16_t **psetup,
82 uint32_t *ptotal_param, uint32_t *pnum_param,
83 uint32_t *pparam_disp, uint8_t **pparam,
84 uint32_t *ptotal_data, uint32_t *pnum_data,
85 uint32_t *pdata_disp, uint8_t **pdata)
87 uint32_t param_ofs, data_ofs;
89 if (expect_first_reply) {
90 if ((wct != 0) || (num_bytes != 0)) {
91 return NT_STATUS_INVALID_NETWORK_RESPONSE;
100 return NT_STATUS_INVALID_NETWORK_RESPONSE;
102 *ptotal_param = SVAL(vwv + 0, 0);
103 *ptotal_data = SVAL(vwv + 1, 0);
104 *pnum_param = SVAL(vwv + 3, 0);
105 param_ofs = SVAL(vwv + 4, 0);
106 *pparam_disp = SVAL(vwv + 5, 0);
107 *pnum_data = SVAL(vwv + 6, 0);
108 data_ofs = SVAL(vwv + 7, 0);
109 *pdata_disp = SVAL(vwv + 8, 0);
110 *pnum_setup = CVAL(vwv + 9, 0);
111 if (wct < 10 + (*pnum_setup)) {
112 return NT_STATUS_INVALID_NETWORK_RESPONSE;
119 return NT_STATUS_INVALID_NETWORK_RESPONSE;
121 *ptotal_param = IVAL(vwv, 3);
122 *ptotal_data = IVAL(vwv, 7);
123 *pnum_param = IVAL(vwv, 11);
124 param_ofs = IVAL(vwv, 15);
125 *pparam_disp = IVAL(vwv, 19);
126 *pnum_data = IVAL(vwv, 23);
127 data_ofs = IVAL(vwv, 27);
128 *pdata_disp = IVAL(vwv, 31);
129 *pnum_setup = CVAL(vwv, 35);
134 return NT_STATUS_INTERNAL_ERROR;
138 * Check for buffer overflows. data_ofs needs to be checked against
139 * the incoming buffer length, data_disp against the total
140 * length. Likewise for param_ofs/param_disp.
143 if (smb_buffer_oob(smb_len_nbt(inbuf), param_ofs, *pnum_param)
144 || smb_buffer_oob(*ptotal_param, *pparam_disp, *pnum_param)
145 || smb_buffer_oob(smb_len_nbt(inbuf), data_ofs, *pnum_data)
146 || smb_buffer_oob(*ptotal_data, *pdata_disp, *pnum_data)) {
147 return NT_STATUS_INVALID_NETWORK_RESPONSE;
150 *pparam = (uint8_t *)inbuf + 4 + param_ofs;
151 *pdata = (uint8_t *)inbuf + 4 + data_ofs;
156 static NTSTATUS cli_trans_pull_blob(TALLOC_CTX *mem_ctx,
157 struct trans_recvblob *blob,
158 uint32_t total, uint32_t thistime,
159 uint8_t *buf, uint32_t displacement)
161 if (blob->data == NULL) {
162 if (total > blob->max) {
163 return NT_STATUS_INVALID_NETWORK_RESPONSE;
166 blob->data = talloc_array(mem_ctx, uint8_t, total);
167 if (blob->data == NULL) {
168 return NT_STATUS_NO_MEMORY;
172 if (total > blob->total) {
173 return NT_STATUS_INVALID_NETWORK_RESPONSE;
177 memcpy(blob->data + displacement, buf, thistime);
178 blob->received += thistime;
184 static void cli_trans_format(struct cli_trans_state *state, uint8_t *pwct,
187 struct cli_state *cli = state->cli;
189 struct iovec *iov = state->iov;
190 uint8_t *pad = state->pad;
191 uint16_t *vwv = state->vwv;
192 uint32_t param_offset;
193 uint32_t this_param = 0;
195 uint32_t data_offset;
196 uint32_t this_data = 0;
198 uint32_t useable_space;
203 if ((state->param_sent != 0) || (state->data_sent != 0)) {
204 /* The secondary commands are one after the primary ones */
208 param_offset = MIN_SMB_SIZE;
212 if (cli_ucs2(state->cli)) {
214 iov[0].iov_base = (void *)pad;
219 iov[0].iov_base = (void *)state->pipe_name_conv;
220 iov[0].iov_len = state->pipe_name_conv_len;
221 wct = 14 + state->num_setup;
222 param_offset += iov[0].iov_len;
227 pad[1] = 'D'; /* Copy this from "old" 3.0 behaviour */
229 iov[0].iov_base = (void *)pad;
231 wct = 14 + state->num_setup;
242 wct = 19 + state->num_setup;
249 param_offset += wct * sizeof(uint16_t);
250 useable_space = cli_state_available_size(cli, param_offset);
252 param_pad = param_offset % 4;
254 param_pad = MIN(param_pad, useable_space);
255 iov[0].iov_base = (void *)state->zero_pad;
256 iov[0].iov_len = param_pad;
258 param_offset += param_pad;
260 useable_space = cli_state_available_size(cli, param_offset);
262 if (state->param_sent < state->num_param) {
263 this_param = MIN(state->num_param - state->param_sent,
265 iov[0].iov_base = (void *)(state->param + state->param_sent);
266 iov[0].iov_len = this_param;
270 data_offset = param_offset + this_param;
271 useable_space = cli_state_available_size(cli, data_offset);
273 data_pad = data_offset % 4;
275 data_pad = MIN(data_pad, useable_space);
276 iov[0].iov_base = (void *)state->zero_pad;
277 iov[0].iov_len = data_pad;
279 data_offset += data_pad;
281 useable_space = cli_state_available_size(cli, data_offset);
283 if (state->data_sent < state->num_data) {
284 this_data = MIN(state->num_data - state->data_sent,
286 iov[0].iov_base = (void *)(state->data + state->data_sent);
287 iov[0].iov_len = this_data;
291 DEBUG(10, ("num_setup=%u, max_setup=%u, "
292 "param_total=%u, this_param=%u, max_param=%u, "
293 "data_total=%u, this_data=%u, max_data=%u, "
294 "param_offset=%u, param_pad=%u, param_disp=%u, "
295 "data_offset=%u, data_pad=%u, data_disp=%u\n",
296 (unsigned)state->num_setup, (unsigned)state->max_setup,
297 (unsigned)state->num_param, (unsigned)this_param,
298 (unsigned)state->rparam.max,
299 (unsigned)state->num_data, (unsigned)this_data,
300 (unsigned)state->rdata.max,
301 (unsigned)param_offset, (unsigned)param_pad,
302 (unsigned)state->param_sent,
303 (unsigned)data_offset, (unsigned)data_pad,
304 (unsigned)state->data_sent));
309 SSVAL(vwv + 0, 0, state->num_param);
310 SSVAL(vwv + 1, 0, state->num_data);
311 SSVAL(vwv + 2, 0, state->rparam.max);
312 SSVAL(vwv + 3, 0, state->rdata.max);
313 SCVAL(vwv + 4, 0, state->max_setup);
314 SCVAL(vwv + 4, 1, 0); /* reserved */
315 SSVAL(vwv + 5, 0, state->flags);
316 SIVAL(vwv + 6, 0, 0); /* timeout */
317 SSVAL(vwv + 8, 0, 0); /* reserved */
318 SSVAL(vwv + 9, 0, this_param);
319 SSVAL(vwv +10, 0, param_offset);
320 SSVAL(vwv +11, 0, this_data);
321 SSVAL(vwv +12, 0, data_offset);
322 SCVAL(vwv +13, 0, state->num_setup);
323 SCVAL(vwv +13, 1, 0); /* reserved */
324 memcpy(vwv + 14, state->setup,
325 sizeof(uint16_t) * state->num_setup);
329 SSVAL(vwv + 0, 0, state->num_param);
330 SSVAL(vwv + 1, 0, state->num_data);
331 SSVAL(vwv + 2, 0, this_param);
332 SSVAL(vwv + 3, 0, param_offset);
333 SSVAL(vwv + 4, 0, state->param_sent);
334 SSVAL(vwv + 5, 0, this_data);
335 SSVAL(vwv + 6, 0, data_offset);
336 SSVAL(vwv + 7, 0, state->data_sent);
337 if (cmd == SMBtranss2) {
338 SSVAL(vwv + 8, 0, state->fid);
342 SCVAL(vwv + 0, 0, state->max_setup);
343 SSVAL(vwv + 0, 1, 0); /* reserved */
344 SIVAL(vwv + 1, 1, state->num_param);
345 SIVAL(vwv + 3, 1, state->num_data);
346 SIVAL(vwv + 5, 1, state->rparam.max);
347 SIVAL(vwv + 7, 1, state->rdata.max);
348 SIVAL(vwv + 9, 1, this_param);
349 SIVAL(vwv +11, 1, param_offset);
350 SIVAL(vwv +13, 1, this_data);
351 SIVAL(vwv +15, 1, data_offset);
352 SCVAL(vwv +17, 1, state->num_setup);
353 SSVAL(vwv +18, 0, state->function);
354 memcpy(vwv + 19, state->setup,
355 sizeof(uint16_t) * state->num_setup);
358 SSVAL(vwv + 0, 0, 0); /* reserved */
359 SCVAL(vwv + 1, 0, 0); /* reserved */
360 SIVAL(vwv + 1, 1, state->num_param);
361 SIVAL(vwv + 3, 1, state->num_data);
362 SIVAL(vwv + 5, 1, this_param);
363 SIVAL(vwv + 7, 1, param_offset);
364 SIVAL(vwv + 9, 1, state->param_sent);
365 SIVAL(vwv +11, 1, this_data);
366 SIVAL(vwv +13, 1, data_offset);
367 SIVAL(vwv +15, 1, state->data_sent);
368 SCVAL(vwv +17, 1, 0); /* reserved */
372 state->param_sent += this_param;
373 state->data_sent += this_data;
376 *piov_count = iov - state->iov;
379 static void cli_trans_done(struct tevent_req *subreq);
381 struct tevent_req *cli_trans_send(
382 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
383 struct cli_state *cli, uint8_t cmd,
384 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
385 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
386 uint8_t *param, uint32_t num_param, uint32_t max_param,
387 uint8_t *data, uint32_t num_data, uint32_t max_data)
389 struct tevent_req *req, *subreq;
390 struct cli_trans_state *state;
395 req = tevent_req_create(mem_ctx, &state, struct cli_trans_state);
400 if ((cmd == SMBtrans) || (cmd == SMBtrans2)) {
401 if ((num_param > 0xffff) || (max_param > 0xffff)
402 || (num_data > 0xffff) || (max_data > 0xffff)) {
403 DEBUG(3, ("Attempt to send invalid trans2 request "
404 "(setup %u, params %u/%u, data %u/%u)\n",
406 (unsigned)num_param, (unsigned)max_param,
407 (unsigned)num_data, (unsigned)max_data));
408 tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER);
409 return tevent_req_post(req, ev);
414 * The largest wct will be for nttrans (19+num_setup). Make sure we
415 * don't overflow state->vwv in cli_trans_format.
418 if ((num_setup + 19) > ARRAY_SIZE(state->vwv)) {
419 tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER);
420 return tevent_req_post(req, ev);
426 state->flags = flags;
427 state->num_rsetup = 0;
428 state->rsetup = NULL;
429 ZERO_STRUCT(state->rparam);
430 ZERO_STRUCT(state->rdata);
432 if ((pipe_name != NULL)
433 && (!convert_string_talloc(state, CH_UNIX,
434 cli_ucs2(cli) ? CH_UTF16LE : CH_DOS,
435 pipe_name, strlen(pipe_name) + 1,
436 &state->pipe_name_conv,
437 &state->pipe_name_conv_len))) {
438 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
439 return tevent_req_post(req, ev);
441 state->fid = fid; /* trans2 */
442 state->function = function; /* nttrans */
444 state->setup = setup;
445 state->num_setup = num_setup;
446 state->max_setup = max_setup;
448 state->param = param;
449 state->num_param = num_param;
450 state->param_sent = 0;
451 state->rparam.max = max_param;
454 state->num_data = num_data;
455 state->data_sent = 0;
456 state->rdata.max = max_data;
458 cli_trans_format(state, &wct, &iov_count);
460 subreq = cli_smb_req_create(state, ev, cli, cmd, 0, wct, state->vwv,
461 iov_count, state->iov);
462 if (tevent_req_nomem(subreq, req)) {
463 return tevent_req_post(req, ev);
465 status = cli_smb_req_send(subreq);
466 if (!NT_STATUS_IS_OK(status)) {
467 tevent_req_nterror(req, status);
468 return tevent_req_post(req, state->ev);
470 tevent_req_set_callback(subreq, cli_trans_done, req);
473 * Now get the MID of the primary request
474 * and mark it as persistent. This means
475 * we will able to send and receive multiple
476 * SMB pdus using this MID in both directions
477 * (including correct SMB signing).
479 state->mid = cli_smb_req_mid(subreq);
480 cli_smb_req_set_mid(subreq, state->mid);
481 state->primary_subreq = subreq;
482 talloc_set_destructor(state, cli_trans_state_destructor);
487 static void cli_trans_done2(struct tevent_req *subreq);
489 static void cli_trans_done(struct tevent_req *subreq)
491 struct tevent_req *req = tevent_req_callback_data(
492 subreq, struct tevent_req);
493 struct cli_trans_state *state = tevent_req_data(
494 req, struct cli_trans_state);
497 const uint8_t *inhdr;
503 uint8_t num_setup = 0;
504 uint16_t *setup = NULL;
505 uint32_t total_param = 0;
506 uint32_t num_param = 0;
507 uint32_t param_disp = 0;
508 uint32_t total_data = 0;
509 uint32_t num_data = 0;
510 uint32_t data_disp = 0;
511 uint8_t *param = NULL;
512 uint8_t *data = NULL;
514 status = cli_smb_recv(subreq, state, &inbuf, 0, &wct, &vwv,
517 * Do not TALLOC_FREE(subreq) here, we might receive more than
518 * one response for the same mid.
522 * We can receive something like STATUS_MORE_ENTRIES, so don't use
523 * !NT_STATUS_IS_OK(status) here.
526 if (NT_STATUS_IS_ERR(status)) {
529 inhdr = inbuf + NBT_HDR_SIZE;
531 sent_all = ((state->param_sent == state->num_param)
532 && (state->data_sent == state->num_data));
534 status = cli_pull_trans(
535 inbuf, wct, vwv, num_bytes, bytes,
536 state->cmd, !sent_all, &num_setup, &setup,
537 &total_param, &num_param, ¶m_disp, ¶m,
538 &total_data, &num_data, &data_disp, &data);
540 if (!NT_STATUS_IS_OK(status)) {
546 struct tevent_req *subreq2;
548 cli_trans_format(state, &wct, &iov_count);
550 subreq2 = cli_smb_req_create(state, state->ev, state->cli,
551 state->cmd + 1, 0, wct, state->vwv,
552 iov_count, state->iov);
553 if (tevent_req_nomem(subreq2, req)) {
556 cli_smb_req_set_mid(subreq2, state->mid);
558 status = cli_smb_req_send(subreq2);
560 if (!NT_STATUS_IS_OK(status)) {
563 tevent_req_set_callback(subreq2, cli_trans_done2, req);
568 status = cli_trans_pull_blob(
569 state, &state->rparam, total_param, num_param, param,
572 if (!NT_STATUS_IS_OK(status)) {
573 DEBUG(10, ("Pulling params failed: %s\n", nt_errstr(status)));
577 status = cli_trans_pull_blob(
578 state, &state->rdata, total_data, num_data, data,
581 if (!NT_STATUS_IS_OK(status)) {
582 DEBUG(10, ("Pulling data failed: %s\n", nt_errstr(status)));
586 if ((state->rparam.total == state->rparam.received)
587 && (state->rdata.total == state->rdata.received)) {
588 state->recv_flags2 = SVAL(inhdr, HDR_FLG2);
589 cli_trans_cleanup_primary(state);
590 tevent_req_done(req);
599 cli_trans_cleanup_primary(state);
600 tevent_req_nterror(req, status);
603 static void cli_trans_done2(struct tevent_req *subreq2)
605 struct tevent_req *req = tevent_req_callback_data(
606 subreq2, struct tevent_req);
607 struct cli_trans_state *state = tevent_req_data(
608 req, struct cli_trans_state);
615 * First backup the seqnum of the secondary request
616 * and attach it to the primary request.
618 seqnum = cli_smb_req_seqnum(subreq2);
619 cli_smb_req_set_seqnum(state->primary_subreq, seqnum);
621 status = cli_smb_recv(subreq2, state, NULL, 0, &wct, NULL,
623 TALLOC_FREE(subreq2);
625 if (!NT_STATUS_IS_OK(status)) {
630 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
634 sent_all = ((state->param_sent == state->num_param)
635 && (state->data_sent == state->num_data));
640 cli_trans_format(state, &wct, &iov_count);
642 subreq2 = cli_smb_req_create(state, state->ev, state->cli,
643 state->cmd + 1, 0, wct, state->vwv,
644 iov_count, state->iov);
645 if (tevent_req_nomem(subreq2, req)) {
648 cli_smb_req_set_mid(subreq2, state->mid);
650 status = cli_smb_req_send(subreq2);
652 if (!NT_STATUS_IS_OK(status)) {
655 tevent_req_set_callback(subreq2, cli_trans_done2, req);
662 cli_trans_cleanup_primary(state);
663 tevent_req_nterror(req, status);
666 NTSTATUS cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
667 uint16_t *recv_flags2,
668 uint16_t **setup, uint8_t min_setup,
670 uint8_t **param, uint32_t min_param,
672 uint8_t **data, uint32_t min_data,
675 struct cli_trans_state *state = tevent_req_data(
676 req, struct cli_trans_state);
679 cli_trans_cleanup_primary(state);
681 if (tevent_req_is_nterror(req, &status)) {
685 if ((state->num_rsetup < min_setup)
686 || (state->rparam.total < min_param)
687 || (state->rdata.total < min_data)) {
688 return NT_STATUS_INVALID_NETWORK_RESPONSE;
691 if (recv_flags2 != NULL) {
692 *recv_flags2 = state->recv_flags2;
696 *setup = talloc_move(mem_ctx, &state->rsetup);
697 *num_setup = state->num_rsetup;
699 TALLOC_FREE(state->rsetup);
703 *param = talloc_move(mem_ctx, &state->rparam.data);
704 *num_param = state->rparam.total;
706 TALLOC_FREE(state->rparam.data);
710 *data = talloc_move(mem_ctx, &state->rdata.data);
711 *num_data = state->rdata.total;
713 TALLOC_FREE(state->rdata.data);
719 NTSTATUS cli_trans(TALLOC_CTX *mem_ctx, struct cli_state *cli,
721 const char *pipe_name, uint16_t fid, uint16_t function,
723 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
724 uint8_t *param, uint32_t num_param, uint32_t max_param,
725 uint8_t *data, uint32_t num_data, uint32_t max_data,
726 uint16_t *recv_flags2,
727 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
728 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
729 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata)
731 TALLOC_CTX *frame = talloc_stackframe();
732 struct tevent_context *ev;
733 struct tevent_req *req;
734 NTSTATUS status = NT_STATUS_OK;
736 if (cli_has_async_calls(cli)) {
738 * Can't use sync call while an async call is in flight
740 status = NT_STATUS_INVALID_PARAMETER;
744 ev = tevent_context_init(frame);
746 status = NT_STATUS_NO_MEMORY;
750 req = cli_trans_send(frame, ev, cli, trans_cmd,
751 pipe_name, fid, function, flags,
752 setup, num_setup, max_setup,
753 param, num_param, max_param,
754 data, num_data, max_data);
756 status = NT_STATUS_NO_MEMORY;
760 if (!tevent_req_poll(req, ev)) {
761 status = map_nt_error_from_unix_common(errno);
765 status = cli_trans_recv(req, mem_ctx, recv_flags2,
766 rsetup, min_rsetup, num_rsetup,
767 rparam, min_rparam, num_rparam,
768 rdata, min_rdata, num_rdata);