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;
88 uint8_t expected_num_setup;
90 if (expect_first_reply) {
91 if ((wct != 0) || (num_bytes != 0)) {
92 return NT_STATUS_INVALID_NETWORK_RESPONSE;
101 return NT_STATUS_INVALID_NETWORK_RESPONSE;
103 expected_num_setup = wct - 10;
104 *ptotal_param = SVAL(vwv + 0, 0);
105 *ptotal_data = SVAL(vwv + 1, 0);
106 *pnum_param = SVAL(vwv + 3, 0);
107 param_ofs = SVAL(vwv + 4, 0);
108 *pparam_disp = SVAL(vwv + 5, 0);
109 *pnum_data = SVAL(vwv + 6, 0);
110 data_ofs = SVAL(vwv + 7, 0);
111 *pdata_disp = SVAL(vwv + 8, 0);
112 *pnum_setup = CVAL(vwv + 9, 0);
113 if (expected_num_setup < (*pnum_setup)) {
114 return NT_STATUS_INVALID_NETWORK_RESPONSE;
121 return NT_STATUS_INVALID_NETWORK_RESPONSE;
123 *ptotal_param = IVAL(vwv, 3);
124 *ptotal_data = IVAL(vwv, 7);
125 *pnum_param = IVAL(vwv, 11);
126 param_ofs = IVAL(vwv, 15);
127 *pparam_disp = IVAL(vwv, 19);
128 *pnum_data = IVAL(vwv, 23);
129 data_ofs = IVAL(vwv, 27);
130 *pdata_disp = IVAL(vwv, 31);
131 *pnum_setup = CVAL(vwv, 35);
136 return NT_STATUS_INTERNAL_ERROR;
140 * Check for buffer overflows. data_ofs needs to be checked against
141 * the incoming buffer length, data_disp against the total
142 * length. Likewise for param_ofs/param_disp.
145 if (smb_buffer_oob(smb_len_nbt(inbuf), param_ofs, *pnum_param)
146 || smb_buffer_oob(*ptotal_param, *pparam_disp, *pnum_param)
147 || smb_buffer_oob(smb_len_nbt(inbuf), data_ofs, *pnum_data)
148 || smb_buffer_oob(*ptotal_data, *pdata_disp, *pnum_data)) {
149 return NT_STATUS_INVALID_NETWORK_RESPONSE;
152 *pparam = (uint8_t *)inbuf + 4 + param_ofs;
153 *pdata = (uint8_t *)inbuf + 4 + data_ofs;
158 static NTSTATUS cli_trans_pull_blob(TALLOC_CTX *mem_ctx,
159 struct trans_recvblob *blob,
160 uint32_t total, uint32_t thistime,
161 uint8_t *buf, uint32_t displacement)
163 if (blob->data == NULL) {
164 if (total > blob->max) {
165 return NT_STATUS_INVALID_NETWORK_RESPONSE;
168 blob->data = talloc_array(mem_ctx, uint8_t, total);
169 if (blob->data == NULL) {
170 return NT_STATUS_NO_MEMORY;
174 if (total > blob->total) {
175 return NT_STATUS_INVALID_NETWORK_RESPONSE;
179 memcpy(blob->data + displacement, buf, thistime);
180 blob->received += thistime;
186 static void cli_trans_format(struct cli_trans_state *state, uint8_t *pwct,
189 struct cli_state *cli = state->cli;
191 struct iovec *iov = state->iov;
192 uint8_t *pad = state->pad;
193 uint16_t *vwv = state->vwv;
194 uint32_t param_offset;
195 uint32_t this_param = 0;
197 uint32_t data_offset;
198 uint32_t this_data = 0;
200 uint32_t useable_space;
205 if ((state->param_sent != 0) || (state->data_sent != 0)) {
206 /* The secondary commands are one after the primary ones */
210 param_offset = MIN_SMB_SIZE;
214 if (cli_ucs2(state->cli)) {
216 iov[0].iov_base = (void *)pad;
221 iov[0].iov_base = (void *)state->pipe_name_conv;
222 iov[0].iov_len = state->pipe_name_conv_len;
223 wct = 14 + state->num_setup;
224 param_offset += iov[0].iov_len;
229 pad[1] = 'D'; /* Copy this from "old" 3.0 behaviour */
231 iov[0].iov_base = (void *)pad;
233 wct = 14 + state->num_setup;
244 wct = 19 + state->num_setup;
251 param_offset += wct * sizeof(uint16_t);
252 useable_space = cli_state_available_size(cli, param_offset);
254 param_pad = param_offset % 4;
256 param_pad = MIN(param_pad, useable_space);
257 iov[0].iov_base = (void *)state->zero_pad;
258 iov[0].iov_len = param_pad;
260 param_offset += param_pad;
262 useable_space = cli_state_available_size(cli, param_offset);
264 if (state->param_sent < state->num_param) {
265 this_param = MIN(state->num_param - state->param_sent,
267 iov[0].iov_base = (void *)(state->param + state->param_sent);
268 iov[0].iov_len = this_param;
272 data_offset = param_offset + this_param;
273 useable_space = cli_state_available_size(cli, data_offset);
275 data_pad = data_offset % 4;
277 data_pad = MIN(data_pad, useable_space);
278 iov[0].iov_base = (void *)state->zero_pad;
279 iov[0].iov_len = data_pad;
281 data_offset += data_pad;
283 useable_space = cli_state_available_size(cli, data_offset);
285 if (state->data_sent < state->num_data) {
286 this_data = MIN(state->num_data - state->data_sent,
288 iov[0].iov_base = (void *)(state->data + state->data_sent);
289 iov[0].iov_len = this_data;
293 DEBUG(10, ("num_setup=%u, max_setup=%u, "
294 "param_total=%u, this_param=%u, max_param=%u, "
295 "data_total=%u, this_data=%u, max_data=%u, "
296 "param_offset=%u, param_pad=%u, param_disp=%u, "
297 "data_offset=%u, data_pad=%u, data_disp=%u\n",
298 (unsigned)state->num_setup, (unsigned)state->max_setup,
299 (unsigned)state->num_param, (unsigned)this_param,
300 (unsigned)state->rparam.max,
301 (unsigned)state->num_data, (unsigned)this_data,
302 (unsigned)state->rdata.max,
303 (unsigned)param_offset, (unsigned)param_pad,
304 (unsigned)state->param_sent,
305 (unsigned)data_offset, (unsigned)data_pad,
306 (unsigned)state->data_sent));
311 SSVAL(vwv + 0, 0, state->num_param);
312 SSVAL(vwv + 1, 0, state->num_data);
313 SSVAL(vwv + 2, 0, state->rparam.max);
314 SSVAL(vwv + 3, 0, state->rdata.max);
315 SCVAL(vwv + 4, 0, state->max_setup);
316 SCVAL(vwv + 4, 1, 0); /* reserved */
317 SSVAL(vwv + 5, 0, state->flags);
318 SIVAL(vwv + 6, 0, 0); /* timeout */
319 SSVAL(vwv + 8, 0, 0); /* reserved */
320 SSVAL(vwv + 9, 0, this_param);
321 SSVAL(vwv +10, 0, param_offset);
322 SSVAL(vwv +11, 0, this_data);
323 SSVAL(vwv +12, 0, data_offset);
324 SCVAL(vwv +13, 0, state->num_setup);
325 SCVAL(vwv +13, 1, 0); /* reserved */
326 memcpy(vwv + 14, state->setup,
327 sizeof(uint16_t) * state->num_setup);
331 SSVAL(vwv + 0, 0, state->num_param);
332 SSVAL(vwv + 1, 0, state->num_data);
333 SSVAL(vwv + 2, 0, this_param);
334 SSVAL(vwv + 3, 0, param_offset);
335 SSVAL(vwv + 4, 0, state->param_sent);
336 SSVAL(vwv + 5, 0, this_data);
337 SSVAL(vwv + 6, 0, data_offset);
338 SSVAL(vwv + 7, 0, state->data_sent);
339 if (cmd == SMBtranss2) {
340 SSVAL(vwv + 8, 0, state->fid);
344 SCVAL(vwv + 0, 0, state->max_setup);
345 SSVAL(vwv + 0, 1, 0); /* reserved */
346 SIVAL(vwv + 1, 1, state->num_param);
347 SIVAL(vwv + 3, 1, state->num_data);
348 SIVAL(vwv + 5, 1, state->rparam.max);
349 SIVAL(vwv + 7, 1, state->rdata.max);
350 SIVAL(vwv + 9, 1, this_param);
351 SIVAL(vwv +11, 1, param_offset);
352 SIVAL(vwv +13, 1, this_data);
353 SIVAL(vwv +15, 1, data_offset);
354 SCVAL(vwv +17, 1, state->num_setup);
355 SSVAL(vwv +18, 0, state->function);
356 memcpy(vwv + 19, state->setup,
357 sizeof(uint16_t) * state->num_setup);
360 SSVAL(vwv + 0, 0, 0); /* reserved */
361 SCVAL(vwv + 1, 0, 0); /* reserved */
362 SIVAL(vwv + 1, 1, state->num_param);
363 SIVAL(vwv + 3, 1, state->num_data);
364 SIVAL(vwv + 5, 1, this_param);
365 SIVAL(vwv + 7, 1, param_offset);
366 SIVAL(vwv + 9, 1, state->param_sent);
367 SIVAL(vwv +11, 1, this_data);
368 SIVAL(vwv +13, 1, data_offset);
369 SIVAL(vwv +15, 1, state->data_sent);
370 SCVAL(vwv +17, 1, 0); /* reserved */
374 state->param_sent += this_param;
375 state->data_sent += this_data;
378 *piov_count = iov - state->iov;
381 static void cli_trans_done(struct tevent_req *subreq);
383 struct tevent_req *cli_trans_send(
384 TALLOC_CTX *mem_ctx, struct tevent_context *ev,
385 struct cli_state *cli, uint8_t cmd,
386 const char *pipe_name, uint16_t fid, uint16_t function, int flags,
387 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
388 uint8_t *param, uint32_t num_param, uint32_t max_param,
389 uint8_t *data, uint32_t num_data, uint32_t max_data)
391 struct tevent_req *req, *subreq;
392 struct cli_trans_state *state;
397 req = tevent_req_create(mem_ctx, &state, struct cli_trans_state);
402 if ((cmd == SMBtrans) || (cmd == SMBtrans2)) {
403 if ((num_param > 0xffff) || (max_param > 0xffff)
404 || (num_data > 0xffff) || (max_data > 0xffff)) {
405 DEBUG(3, ("Attempt to send invalid trans2 request "
406 "(setup %u, params %u/%u, data %u/%u)\n",
408 (unsigned)num_param, (unsigned)max_param,
409 (unsigned)num_data, (unsigned)max_data));
410 tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER);
411 return tevent_req_post(req, ev);
416 * The largest wct will be for nttrans (19+num_setup). Make sure we
417 * don't overflow state->vwv in cli_trans_format.
420 if ((num_setup + 19) > ARRAY_SIZE(state->vwv)) {
421 tevent_req_nterror(req, NT_STATUS_INVALID_PARAMETER);
422 return tevent_req_post(req, ev);
428 state->flags = flags;
429 state->num_rsetup = 0;
430 state->rsetup = NULL;
431 ZERO_STRUCT(state->rparam);
432 ZERO_STRUCT(state->rdata);
434 if ((pipe_name != NULL)
435 && (!convert_string_talloc(state, CH_UNIX,
436 cli_ucs2(cli) ? CH_UTF16LE : CH_DOS,
437 pipe_name, strlen(pipe_name) + 1,
438 &state->pipe_name_conv,
439 &state->pipe_name_conv_len))) {
440 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
441 return tevent_req_post(req, ev);
443 state->fid = fid; /* trans2 */
444 state->function = function; /* nttrans */
446 state->setup = setup;
447 state->num_setup = num_setup;
448 state->max_setup = max_setup;
450 state->param = param;
451 state->num_param = num_param;
452 state->param_sent = 0;
453 state->rparam.max = max_param;
456 state->num_data = num_data;
457 state->data_sent = 0;
458 state->rdata.max = max_data;
460 cli_trans_format(state, &wct, &iov_count);
462 subreq = cli_smb_req_create(state, ev, cli, cmd, 0, wct, state->vwv,
463 iov_count, state->iov);
464 if (tevent_req_nomem(subreq, req)) {
465 return tevent_req_post(req, ev);
467 status = cli_smb_req_send(subreq);
468 if (!NT_STATUS_IS_OK(status)) {
469 tevent_req_nterror(req, status);
470 return tevent_req_post(req, state->ev);
472 tevent_req_set_callback(subreq, cli_trans_done, req);
475 * Now get the MID of the primary request
476 * and mark it as persistent. This means
477 * we will able to send and receive multiple
478 * SMB pdus using this MID in both directions
479 * (including correct SMB signing).
481 state->mid = cli_smb_req_mid(subreq);
482 cli_smb_req_set_mid(subreq, state->mid);
483 state->primary_subreq = subreq;
484 talloc_set_destructor(state, cli_trans_state_destructor);
489 static void cli_trans_done2(struct tevent_req *subreq);
491 static void cli_trans_done(struct tevent_req *subreq)
493 struct tevent_req *req = tevent_req_callback_data(
494 subreq, struct tevent_req);
495 struct cli_trans_state *state = tevent_req_data(
496 req, struct cli_trans_state);
499 const uint8_t *inhdr;
505 uint8_t num_setup = 0;
506 uint16_t *setup = NULL;
507 uint32_t total_param = 0;
508 uint32_t num_param = 0;
509 uint32_t param_disp = 0;
510 uint32_t total_data = 0;
511 uint32_t num_data = 0;
512 uint32_t data_disp = 0;
513 uint8_t *param = NULL;
514 uint8_t *data = NULL;
516 status = cli_smb_recv(subreq, state, &inbuf, 0, &wct, &vwv,
519 * Do not TALLOC_FREE(subreq) here, we might receive more than
520 * one response for the same mid.
524 * We can receive something like STATUS_MORE_ENTRIES, so don't use
525 * !NT_STATUS_IS_OK(status) here.
528 if (NT_STATUS_IS_ERR(status)) {
531 inhdr = inbuf + NBT_HDR_SIZE;
533 sent_all = ((state->param_sent == state->num_param)
534 && (state->data_sent == state->num_data));
536 status = cli_pull_trans(
537 inbuf, wct, vwv, num_bytes, bytes,
538 state->cmd, !sent_all, &num_setup, &setup,
539 &total_param, &num_param, ¶m_disp, ¶m,
540 &total_data, &num_data, &data_disp, &data);
542 if (!NT_STATUS_IS_OK(status)) {
548 struct tevent_req *subreq2;
550 cli_trans_format(state, &wct, &iov_count);
552 subreq2 = cli_smb_req_create(state, state->ev, state->cli,
553 state->cmd + 1, 0, wct, state->vwv,
554 iov_count, state->iov);
555 if (tevent_req_nomem(subreq2, req)) {
558 cli_smb_req_set_mid(subreq2, state->mid);
560 status = cli_smb_req_send(subreq2);
562 if (!NT_STATUS_IS_OK(status)) {
565 tevent_req_set_callback(subreq2, cli_trans_done2, req);
570 status = cli_trans_pull_blob(
571 state, &state->rparam, total_param, num_param, param,
574 if (!NT_STATUS_IS_OK(status)) {
575 DEBUG(10, ("Pulling params failed: %s\n", nt_errstr(status)));
579 status = cli_trans_pull_blob(
580 state, &state->rdata, total_data, num_data, data,
583 if (!NT_STATUS_IS_OK(status)) {
584 DEBUG(10, ("Pulling data failed: %s\n", nt_errstr(status)));
588 if ((state->rparam.total == state->rparam.received)
589 && (state->rdata.total == state->rdata.received)) {
590 state->recv_flags2 = SVAL(inhdr, HDR_FLG2);
591 cli_trans_cleanup_primary(state);
592 tevent_req_done(req);
601 cli_trans_cleanup_primary(state);
602 tevent_req_nterror(req, status);
605 static void cli_trans_done2(struct tevent_req *subreq2)
607 struct tevent_req *req = tevent_req_callback_data(
608 subreq2, struct tevent_req);
609 struct cli_trans_state *state = tevent_req_data(
610 req, struct cli_trans_state);
617 * First backup the seqnum of the secondary request
618 * and attach it to the primary request.
620 seqnum = cli_smb_req_seqnum(subreq2);
621 cli_smb_req_set_seqnum(state->primary_subreq, seqnum);
623 status = cli_smb_recv(subreq2, state, NULL, 0, &wct, NULL,
625 TALLOC_FREE(subreq2);
627 if (!NT_STATUS_IS_OK(status)) {
632 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
636 sent_all = ((state->param_sent == state->num_param)
637 && (state->data_sent == state->num_data));
642 cli_trans_format(state, &wct, &iov_count);
644 subreq2 = cli_smb_req_create(state, state->ev, state->cli,
645 state->cmd + 1, 0, wct, state->vwv,
646 iov_count, state->iov);
647 if (tevent_req_nomem(subreq2, req)) {
650 cli_smb_req_set_mid(subreq2, state->mid);
652 status = cli_smb_req_send(subreq2);
654 if (!NT_STATUS_IS_OK(status)) {
657 tevent_req_set_callback(subreq2, cli_trans_done2, req);
664 cli_trans_cleanup_primary(state);
665 tevent_req_nterror(req, status);
668 NTSTATUS cli_trans_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
669 uint16_t *recv_flags2,
670 uint16_t **setup, uint8_t min_setup,
672 uint8_t **param, uint32_t min_param,
674 uint8_t **data, uint32_t min_data,
677 struct cli_trans_state *state = tevent_req_data(
678 req, struct cli_trans_state);
681 cli_trans_cleanup_primary(state);
683 if (tevent_req_is_nterror(req, &status)) {
687 if ((state->num_rsetup < min_setup)
688 || (state->rparam.total < min_param)
689 || (state->rdata.total < min_data)) {
690 return NT_STATUS_INVALID_NETWORK_RESPONSE;
693 if (recv_flags2 != NULL) {
694 *recv_flags2 = state->recv_flags2;
698 *setup = talloc_move(mem_ctx, &state->rsetup);
699 *num_setup = state->num_rsetup;
701 TALLOC_FREE(state->rsetup);
705 *param = talloc_move(mem_ctx, &state->rparam.data);
706 *num_param = state->rparam.total;
708 TALLOC_FREE(state->rparam.data);
712 *data = talloc_move(mem_ctx, &state->rdata.data);
713 *num_data = state->rdata.total;
715 TALLOC_FREE(state->rdata.data);
721 NTSTATUS cli_trans(TALLOC_CTX *mem_ctx, struct cli_state *cli,
723 const char *pipe_name, uint16_t fid, uint16_t function,
725 uint16_t *setup, uint8_t num_setup, uint8_t max_setup,
726 uint8_t *param, uint32_t num_param, uint32_t max_param,
727 uint8_t *data, uint32_t num_data, uint32_t max_data,
728 uint16_t *recv_flags2,
729 uint16_t **rsetup, uint8_t min_rsetup, uint8_t *num_rsetup,
730 uint8_t **rparam, uint32_t min_rparam, uint32_t *num_rparam,
731 uint8_t **rdata, uint32_t min_rdata, uint32_t *num_rdata)
733 TALLOC_CTX *frame = talloc_stackframe();
734 struct tevent_context *ev;
735 struct tevent_req *req;
736 NTSTATUS status = NT_STATUS_OK;
738 if (cli_has_async_calls(cli)) {
740 * Can't use sync call while an async call is in flight
742 status = NT_STATUS_INVALID_PARAMETER;
746 ev = tevent_context_init(frame);
748 status = NT_STATUS_NO_MEMORY;
752 req = cli_trans_send(frame, ev, cli, trans_cmd,
753 pipe_name, fid, function, flags,
754 setup, num_setup, max_setup,
755 param, num_param, max_param,
756 data, num_data, max_data);
758 status = NT_STATUS_NO_MEMORY;
762 if (!tevent_req_poll(req, ev)) {
763 status = map_nt_error_from_unix_common(errno);
767 status = cli_trans_recv(req, mem_ctx, recv_flags2,
768 rsetup, min_rsetup, num_rsetup,
769 rparam, min_rparam, num_rparam,
770 rdata, min_rdata, num_rdata);