Add a doxygen comment line I forgot to merge
[tprouty/samba.git] / source3 / libsmb / async_smb.c
1 /*
2    Unix SMB/CIFS implementation.
3    Infrastructure for async SMB client requests
4    Copyright (C) Volker Lendecke 2008
5
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.
10
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.
15
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/>.
18 */
19
20 #include "includes.h"
21
22 static void cli_state_handler(struct event_context *event_ctx,
23                               struct fd_event *event, uint16 flags, void *p);
24
25 /**
26  * Fetch an error out of a NBT packet
27  * @param[in] buf       The SMB packet
28  * @retval              The error, converted to NTSTATUS
29  */
30
31 NTSTATUS cli_pull_error(char *buf)
32 {
33         uint32_t flags2 = SVAL(buf, smb_flg2);
34
35         if (flags2 & FLAGS2_32_BIT_ERROR_CODES) {
36                 return NT_STATUS(IVAL(buf, smb_rcls));
37         }
38
39         /* if the client uses dos errors, but there is no error,
40            we should return no error here, otherwise it looks
41            like an unknown bad NT_STATUS. jmcd */
42         if (CVAL(buf, smb_rcls) == 0)
43                 return NT_STATUS_OK;
44
45         return NT_STATUS_DOS(CVAL(buf, smb_rcls), SVAL(buf,smb_err));
46 }
47
48 /**
49  * Compatibility helper for the sync APIs: Fake NTSTATUS in cli->inbuf
50  * @param[in] cli       The client connection that just received an error
51  * @param[in] status    The error to set on "cli"
52  */
53
54 void cli_set_error(struct cli_state *cli, NTSTATUS status)
55 {
56         uint32_t flags2 = SVAL(cli->inbuf, smb_flg2);
57
58         if (NT_STATUS_IS_DOS(status)) {
59                 SSVAL(cli->inbuf, smb_flg2,
60                       flags2 & ~FLAGS2_32_BIT_ERROR_CODES);
61                 SCVAL(cli->inbuf, smb_rcls, NT_STATUS_DOS_CLASS(status));
62                 SSVAL(cli->inbuf, smb_err, NT_STATUS_DOS_CODE(status));
63                 return;
64         }
65
66         SSVAL(cli->inbuf, smb_flg2, flags2 | FLAGS2_32_BIT_ERROR_CODES);
67         SIVAL(cli->inbuf, smb_rcls, NT_STATUS_V(status));
68         return;
69 }
70
71 /**
72  * Allocate a new mid
73  * @param[in] cli       The client connection
74  * @retval              The new, unused mid
75  */
76
77 static uint16_t cli_new_mid(struct cli_state *cli)
78 {
79         uint16_t result;
80         struct cli_request *req;
81
82         while (true) {
83                 result = cli->mid++;
84                 if (result == 0) {
85                         continue;
86                 }
87
88                 for (req = cli->outstanding_requests; req; req = req->next) {
89                         if (result == req->mid) {
90                                 break;
91                         }
92                 }
93
94                 if (req == NULL) {
95                         return result;
96                 }
97         }
98 }
99
100 /**
101  * Print an async req that happens to be a cli_request
102  * @param[in] mem_ctx   The TALLOC_CTX to put the result on
103  * @param[in] req       The request to print
104  * @retval              The string representation of "req"
105  */
106
107 static char *cli_request_print(TALLOC_CTX *mem_ctx, struct async_req *req)
108 {
109         char *result = async_req_print(mem_ctx, req);
110         struct cli_request *cli_req = talloc_get_type_abort(
111                 req->private_data, struct cli_request);
112
113         if (result == NULL) {
114                 return NULL;
115         }
116
117         return talloc_asprintf_append_buffer(
118                 result, "mid=%d\n", cli_req->mid);
119 }
120
121 /**
122  * Destroy a cli_request
123  * @param[in] req       The cli_request to kill
124  * @retval Can't fail
125  */
126
127 static int cli_request_destructor(struct cli_request *req)
128 {
129         if (req->enc_state != NULL) {
130                 common_free_enc_buffer(req->enc_state, (char *)req->outbuf);
131         }
132         DLIST_REMOVE(req->cli->outstanding_requests, req);
133         if (req->cli->outstanding_requests == NULL) {
134                 TALLOC_FREE(req->cli->fd_event);
135         }
136         return 0;
137 }
138
139 /**
140  * Are there already requests waiting in the chain_accumulator?
141  * @param[in] cli       The cli_state we want to check
142  * @retval reply :-)
143  */
144
145 bool cli_in_chain(struct cli_state *cli)
146 {
147         if (cli->chain_accumulator == NULL) {
148                 return false;
149         }
150
151         return (cli->chain_accumulator->num_async != 0);
152 }
153
154 /**
155  * Is the SMB command able to hold an AND_X successor
156  * @param[in] cmd       The SMB command in question
157  * @retval Can we add a chained request after "cmd"?
158  */
159
160 static bool is_andx_req(uint8_t cmd)
161 {
162         switch (cmd) {
163         case SMBtconX:
164         case SMBlockingX:
165         case SMBopenX:
166         case SMBreadX:
167         case SMBwriteX:
168         case SMBsesssetupX:
169         case SMBulogoffX:
170         case SMBntcreateX:
171                 return true;
172                 break;
173         default:
174                 break;
175         }
176
177         return false;
178 }
179
180 /**
181  * @brief Find the smb_cmd offset of the last command pushed
182  * @param[in] buf       The buffer we're building up
183  * @retval              Where can we put our next andx cmd?
184  *
185  * While chaining requests, the "next" request we're looking at needs to put
186  * its SMB_Command before the data the previous request already built up added
187  * to the chain. Find the offset to the place where we have to put our cmd.
188  */
189
190 static bool find_andx_cmd_ofs(uint8_t *buf, size_t *pofs)
191 {
192         uint8_t cmd;
193         size_t ofs;
194
195         cmd = CVAL(buf, smb_com);
196
197         SMB_ASSERT(is_andx_req(cmd));
198
199         ofs = smb_vwv0;
200
201         while (CVAL(buf, ofs) != 0xff) {
202
203                 if (!is_andx_req(CVAL(buf, ofs))) {
204                         return false;
205                 }
206
207                 /*
208                  * ofs is from start of smb header, so add the 4 length
209                  * bytes. The next cmd is right after the wct field.
210                  */
211                 ofs = SVAL(buf, ofs+2) + 4 + 1;
212
213                 SMB_ASSERT(ofs+4 < talloc_get_size(buf));
214         }
215
216         *pofs = ofs;
217         return true;
218 }
219
220 /**
221  * @brief Do the smb chaining at a buffer level
222  * @param[in] poutbuf           Pointer to the talloc'ed buffer to be modified
223  * @param[in] smb_command       The command that we want to issue
224  * @param[in] wct               How many words?
225  * @param[in] vwv               The words, already in network order
226  * @param[in] bytes_alignment   How shall we align "bytes"?
227  * @param[in] num_bytes         How many bytes?
228  * @param[in] bytes             The data the request ships
229  *
230  * smb_splice_chain() adds the vwv and bytes to the request already present in
231  * *poutbuf.
232  */
233
234 bool smb_splice_chain(uint8_t **poutbuf, uint8_t smb_command,
235                       uint8_t wct, const uint16_t *vwv,
236                       size_t bytes_alignment,
237                       uint32_t num_bytes, const uint8_t *bytes)
238 {
239         uint8_t *outbuf;
240         size_t old_size, new_size;
241         size_t ofs;
242         size_t chain_padding = 0;
243         size_t bytes_padding = 0;
244         bool first_request;
245
246         old_size = talloc_get_size(*poutbuf);
247
248         /*
249          * old_size == smb_wct means we're pushing the first request in for
250          * libsmb/
251          */
252
253         first_request = (old_size == smb_wct);
254
255         if (!first_request && ((old_size % 4) != 0)) {
256                 /*
257                  * Align the wct field of subsequent requests to a 4-byte
258                  * boundary
259                  */
260                 chain_padding = 4 - (old_size % 4);
261         }
262
263         /*
264          * After the old request comes the new wct field (1 byte), the vwv's
265          * and the num_bytes field. After at we might need to align the bytes
266          * given to us to "bytes_alignment", increasing the num_bytes value.
267          */
268
269         new_size = old_size + chain_padding + 1 + wct * sizeof(uint16_t) + 2;
270
271         if ((bytes_alignment != 0) && ((new_size % bytes_alignment) != 0)) {
272                 bytes_padding = bytes_alignment - (new_size % bytes_alignment);
273         }
274
275         new_size += bytes_padding + num_bytes;
276
277         if ((smb_command != SMBwriteX) && (new_size > 0xffff)) {
278                 DEBUG(1, ("splice_chain: %u bytes won't fit\n",
279                           (unsigned)new_size));
280                 return false;
281         }
282
283         outbuf = TALLOC_REALLOC_ARRAY(NULL, *poutbuf, uint8_t, new_size);
284         if (outbuf == NULL) {
285                 DEBUG(0, ("talloc failed\n"));
286                 return false;
287         }
288         *poutbuf = outbuf;
289
290         if (first_request) {
291                 SCVAL(outbuf, smb_com, smb_command);
292         } else {
293                 size_t andx_cmd_ofs;
294
295                 if (!find_andx_cmd_ofs(outbuf, &andx_cmd_ofs)) {
296                         DEBUG(1, ("invalid command chain\n"));
297                         *poutbuf = TALLOC_REALLOC_ARRAY(
298                                 NULL, *poutbuf, uint8_t, old_size);
299                         return false;
300                 }
301
302                 if (chain_padding != 0) {
303                         memset(outbuf + old_size, 0, chain_padding);
304                         old_size += chain_padding;
305                 }
306
307                 SCVAL(outbuf, andx_cmd_ofs, smb_command);
308                 SSVAL(outbuf, andx_cmd_ofs + 2, old_size - 4);
309         }
310
311         ofs = old_size;
312
313         /*
314          * Push the chained request:
315          *
316          * wct field
317          */
318
319         SCVAL(outbuf, ofs, wct);
320         ofs += 1;
321
322         /*
323          * vwv array
324          */
325
326         memcpy(outbuf + ofs, vwv, sizeof(uint16_t) * wct);
327         ofs += sizeof(uint16_t) * wct;
328
329         /*
330          * bcc (byte count)
331          */
332
333         SSVAL(outbuf, ofs, num_bytes + bytes_padding);
334         ofs += sizeof(uint16_t);
335
336         /*
337          * padding
338          */
339
340         if (bytes_padding != 0) {
341                 memset(outbuf + ofs, 0, bytes_padding);
342                 ofs += bytes_padding;
343         }
344
345         /*
346          * The bytes field
347          */
348
349         memcpy(outbuf + ofs, bytes, num_bytes);
350
351         return true;
352 }
353
354 /**
355  * @brief Destroy an async_req that is the visible part of a cli_request
356  * @param[in] req       The request to kill
357  * @retval Return 0 to make talloc happy
358  *
359  * This destructor is a bit tricky: Because a cli_request can host more than
360  * one async_req for chained requests, we need to make sure that the
361  * "cli_request" that we were part of is correctly destroyed at the right
362  * time. This is done by NULLing out ourself from the "async" member of our
363  * "cli_request". If there is none left, then also TALLOC_FREE() the
364  * cli_request, which was a talloc child of the client connection cli_state.
365  */
366
367 static int cli_async_req_destructor(struct async_req *req)
368 {
369         struct cli_request *cli_req = talloc_get_type_abort(
370                 req->private_data, struct cli_request);
371         int i, pending;
372         bool found = false;
373
374         pending = 0;
375
376         for (i=0; i<cli_req->num_async; i++) {
377                 if (cli_req->async[i] == req) {
378                         cli_req->async[i] = NULL;
379                         found = true;
380                 }
381                 if (cli_req->async[i] != NULL) {
382                         pending += 1;
383                 }
384         }
385
386         SMB_ASSERT(found);
387
388         if (pending == 0) {
389                 TALLOC_FREE(cli_req);
390         }
391
392         return 0;
393 }
394
395 /**
396  * @brief Chain up a request
397  * @param[in] mem_ctx           The TALLOC_CTX for the result
398  * @param[in] ev                The event context that will call us back
399  * @param[in] cli               The cli_state we queue the request up for
400  * @param[in] smb_command       The command that we want to issue
401  * @param[in] additional_flags  open_and_x wants to add oplock header flags
402  * @param[in] wct               How many words?
403  * @param[in] vwv               The words, already in network order
404  * @param[in] bytes_alignment   How shall we align "bytes"?
405  * @param[in] num_bytes         How many bytes?
406  * @param[in] bytes             The data the request ships
407  *
408  * cli_request_chain() is the core of the SMB request marshalling routine. It
409  * will create a new async_req structure in the cli->chain_accumulator->async
410  * array and marshall the smb_cmd, the vwv array and the bytes into
411  * cli->chain_accumulator->outbuf.
412  */
413
414 static struct async_req *cli_request_chain(TALLOC_CTX *mem_ctx,
415                                            struct event_context *ev,
416                                            struct cli_state *cli,
417                                            uint8_t smb_command,
418                                            uint8_t additional_flags,
419                                            uint8_t wct, const uint16_t *vwv,
420                                            size_t bytes_alignment,
421                                            uint32_t num_bytes,
422                                            const uint8_t *bytes)
423 {
424         struct async_req **tmp_reqs;
425         struct cli_request *req;
426
427         req = cli->chain_accumulator;
428
429         tmp_reqs = TALLOC_REALLOC_ARRAY(req, req->async, struct async_req *,
430                                         req->num_async + 1);
431         if (tmp_reqs == NULL) {
432                 DEBUG(0, ("talloc failed\n"));
433                 return NULL;
434         }
435         req->async = tmp_reqs;
436         req->num_async += 1;
437
438         req->async[req->num_async-1] = async_req_new(mem_ctx, ev);
439         if (req->async[req->num_async-1] == NULL) {
440                 DEBUG(0, ("async_req_new failed\n"));
441                 req->num_async -= 1;
442                 return NULL;
443         }
444         req->async[req->num_async-1]->private_data = req;
445         req->async[req->num_async-1]->print = cli_request_print;
446         talloc_set_destructor(req->async[req->num_async-1],
447                               cli_async_req_destructor);
448
449         if (!smb_splice_chain(&req->outbuf, smb_command, wct, vwv,
450                               bytes_alignment, num_bytes, bytes)) {
451                 goto fail;
452         }
453
454         return req->async[req->num_async-1];
455
456  fail:
457         TALLOC_FREE(req->async[req->num_async-1]);
458         req->num_async -= 1;
459         return NULL;
460 }
461
462 /**
463  * @brief prepare a cli_state to accept a chain of requests
464  * @param[in] cli       The cli_state we want to queue up in
465  * @param[in] ev        The event_context that will call us back for the socket
466  * @param[in] size_hint How many bytes are expected, just an optimization
467  * @retval Did we have enough memory?
468  *
469  * cli_chain_cork() sets up a new cli_request in cli->chain_accumulator. If
470  * cli is used in an async fashion, i.e. if we have outstanding requests, then
471  * we do not have to create a fd event. If cli is used only with the sync
472  * helpers, we need to create the fd_event here.
473  *
474  * If you want to issue a chained request to the server, do a
475  * cli_chain_cork(), then do you cli_open_send(), cli_read_and_x_send(),
476  * cli_close_send() and so on. The async requests that come out of
477  * cli_xxx_send() are normal async requests with the difference that they
478  * won't be shipped individually. But the event_context will still trigger the
479  * req->async.fn to be called on every single request.
480  *
481  * You have to take care yourself that you only issue chainable requests in
482  * the middle of the chain.
483  */
484
485 bool cli_chain_cork(struct cli_state *cli, struct event_context *ev,
486                     size_t size_hint)
487 {
488         struct cli_request *req = NULL;
489
490         SMB_ASSERT(cli->chain_accumulator == NULL);
491
492         if (cli->fd == -1) {
493                 DEBUG(10, ("cli->fd closed\n"));
494                 return false;
495         }
496
497         if (cli->fd_event == NULL) {
498                 SMB_ASSERT(cli->outstanding_requests == NULL);
499                 cli->fd_event = event_add_fd(ev, cli, cli->fd,
500                                              EVENT_FD_READ,
501                                              cli_state_handler, cli);
502                 if (cli->fd_event == NULL) {
503                         return false;
504                 }
505         }
506
507         req = talloc(cli, struct cli_request);
508         if (req == NULL) {
509                 goto fail;
510         }
511         req->cli = cli;
512
513         if (size_hint == 0) {
514                 size_hint = 100;
515         }
516         req->outbuf = talloc_array(req, uint8_t, smb_wct + size_hint);
517         if (req->outbuf == NULL) {
518                 goto fail;
519         }
520         req->outbuf = TALLOC_REALLOC_ARRAY(NULL, req->outbuf, uint8_t,
521                                            smb_wct);
522
523         req->num_async = 0;
524         req->async = NULL;
525
526         req->enc_state = NULL;
527         req->recv_helper.fn = NULL;
528
529         SSVAL(req->outbuf, smb_tid, cli->cnum);
530         cli_setup_packet_buf(cli, (char *)req->outbuf);
531
532         req->mid = cli_new_mid(cli);
533
534         cli->chain_accumulator = req;
535
536         DEBUG(10, ("cli_chain_cork: mid=%d\n", req->mid));
537
538         return true;
539  fail:
540         TALLOC_FREE(req);
541         if (cli->outstanding_requests == NULL) {
542                 TALLOC_FREE(cli->fd_event);
543         }
544         return false;
545 }
546
547 /**
548  * Ship a request queued up via cli_request_chain()
549  * @param[in] cl        The connection
550  */
551
552 void cli_chain_uncork(struct cli_state *cli)
553 {
554         struct cli_request *req = cli->chain_accumulator;
555
556         SMB_ASSERT(req != NULL);
557
558         DLIST_ADD_END(cli->outstanding_requests, req, struct cli_request *);
559         talloc_set_destructor(req, cli_request_destructor);
560
561         cli->chain_accumulator = NULL;
562
563         SSVAL(req->outbuf, smb_mid, req->mid);
564         smb_setlen((char *)req->outbuf, talloc_get_size(req->outbuf) - 4);
565
566         cli_calculate_sign_mac(cli, (char *)req->outbuf);
567
568         if (cli_encryption_on(cli)) {
569                 NTSTATUS status;
570                 char *enc_buf;
571
572                 status = cli_encrypt_message(cli, (char *)req->outbuf,
573                                              &enc_buf);
574                 if (!NT_STATUS_IS_OK(status)) {
575                         DEBUG(0, ("Error in encrypting client message. "
576                                   "Error %s\n", nt_errstr(status)));
577                         TALLOC_FREE(req);
578                         return;
579                 }
580                 req->outbuf = (uint8_t *)enc_buf;
581                 req->enc_state = cli->trans_enc_state;
582         }
583
584         req->sent = 0;
585
586         event_fd_set_writeable(cli->fd_event);
587 }
588
589 /**
590  * @brief Send a request to the server
591  * @param[in] mem_ctx           The TALLOC_CTX for the result
592  * @param[in] ev                The event context that will call us back
593  * @param[in] cli               The cli_state we queue the request up for
594  * @param[in] smb_command       The command that we want to issue
595  * @param[in] additional_flags  open_and_x wants to add oplock header flags
596  * @param[in] wct               How many words?
597  * @param[in] vwv               The words, already in network order
598  * @param[in] bytes_alignment   How shall we align "bytes"?
599  * @param[in] num_bytes         How many bytes?
600  * @param[in] bytes             The data the request ships
601  *
602  * This is the generic routine to be used by the cli_xxx_send routines.
603  */
604
605 struct async_req *cli_request_send(TALLOC_CTX *mem_ctx,
606                                    struct event_context *ev,
607                                    struct cli_state *cli,
608                                    uint8_t smb_command,
609                                    uint8_t additional_flags,
610                                    uint8_t wct, const uint16_t *vwv,
611                                    size_t bytes_alignment,
612                                    uint32_t num_bytes, const uint8_t *bytes)
613 {
614         struct async_req *result;
615         bool uncork = false;
616
617         if (cli->chain_accumulator == NULL) {
618                 if (!cli_chain_cork(cli, ev,
619                                     wct * sizeof(uint16_t) + num_bytes + 3)) {
620                         DEBUG(1, ("cli_chain_cork failed\n"));
621                         return NULL;
622                 }
623                 uncork = true;
624         }
625
626         result = cli_request_chain(mem_ctx, ev, cli, smb_command,
627                                    additional_flags, wct, vwv, bytes_alignment,
628                                    num_bytes, bytes);
629
630         if (result == NULL) {
631                 DEBUG(1, ("cli_request_chain failed\n"));
632         }
633
634         if (uncork) {
635                 cli_chain_uncork(cli);
636         }
637
638         return result;
639 }
640
641 /**
642  * Figure out if there is an andx command behind the current one
643  * @param[in] buf       The smb buffer to look at
644  * @param[in] ofs       The offset to the wct field that is followed by the cmd
645  * @retval Is there a command following?
646  */
647
648 static bool have_andx_command(const char *buf, uint16_t ofs)
649 {
650         uint8_t wct;
651         size_t buflen = talloc_get_size(buf);
652
653         if ((ofs == buflen-1) || (ofs == buflen)) {
654                 return false;
655         }
656
657         wct = CVAL(buf, ofs);
658         if (wct < 2) {
659                 /*
660                  * Not enough space for the command and a following pointer
661                  */
662                 return false;
663         }
664         return (CVAL(buf, ofs+1) != 0xff);
665 }
666
667 /**
668  * @brief Pull reply data out of a request
669  * @param[in] req               The request that we just received a reply for
670  * @param[out] pwct             How many words did the server send?
671  * @param[out] pvwv             The words themselves
672  * @param[out] pnum_bytes       How many bytes did the server send?
673  * @param[out] pbytes           The bytes themselves
674  * @retval Was the reply formally correct?
675  */
676
677 NTSTATUS cli_pull_reply(struct async_req *req,
678                         uint8_t *pwct, uint16_t **pvwv,
679                         uint16_t *pnum_bytes, uint8_t **pbytes)
680 {
681         struct cli_request *cli_req = talloc_get_type_abort(
682                 req->private_data, struct cli_request);
683         uint8_t wct, cmd;
684         uint16_t num_bytes;
685         size_t wct_ofs, bytes_offset;
686         int i, j;
687         NTSTATUS status;
688
689         for (i = 0; i < cli_req->num_async; i++) {
690                 if (req == cli_req->async[i]) {
691                         break;
692                 }
693         }
694
695         if (i == cli_req->num_async) {
696                 cli_set_error(cli_req->cli, NT_STATUS_INVALID_PARAMETER);
697                 return NT_STATUS_INVALID_PARAMETER;
698         }
699
700         /**
701          * The status we pull here is only relevant for the last reply in the
702          * chain.
703          */
704
705         status = cli_pull_error(cli_req->inbuf);
706
707         if (i == 0) {
708                 if (NT_STATUS_IS_ERR(status)
709                     && !have_andx_command(cli_req->inbuf, smb_wct)) {
710                         cli_set_error(cli_req->cli, status);
711                         return status;
712                 }
713                 wct_ofs = smb_wct;
714                 goto done;
715         }
716
717         cmd = CVAL(cli_req->inbuf, smb_com);
718         wct_ofs = smb_wct;
719
720         for (j = 0; j < i; j++) {
721                 if (j < i-1) {
722                         if (cmd == 0xff) {
723                                 return NT_STATUS_REQUEST_ABORTED;
724                         }
725                         if (!is_andx_req(cmd)) {
726                                 return NT_STATUS_INVALID_NETWORK_RESPONSE;
727                         }
728                 }
729
730                 if (!have_andx_command(cli_req->inbuf, wct_ofs)) {
731                         /*
732                          * This request was not completed because a previous
733                          * request in the chain had received an error.
734                          */
735                         return NT_STATUS_REQUEST_ABORTED;
736                 }
737
738                 wct_ofs = SVAL(cli_req->inbuf, wct_ofs + 3);
739
740                 /*
741                  * Skip the all-present length field. No overflow, we've just
742                  * put a 16-bit value into a size_t.
743                  */
744                 wct_ofs += 4;
745
746                 if (wct_ofs+2 > talloc_get_size(cli_req->inbuf)) {
747                         return NT_STATUS_INVALID_NETWORK_RESPONSE;
748                 }
749
750                 cmd = CVAL(cli_req->inbuf, wct_ofs + 1);
751         }
752
753         if (!have_andx_command(cli_req->inbuf, wct_ofs)
754             && NT_STATUS_IS_ERR(status)) {
755                 /*
756                  * The last command takes the error code. All further commands
757                  * down the requested chain will get a
758                  * NT_STATUS_REQUEST_ABORTED.
759                  */
760                 return status;
761         }
762
763  done:
764         wct = CVAL(cli_req->inbuf, wct_ofs);
765
766         bytes_offset = wct_ofs + 1 + wct * sizeof(uint16_t);
767         num_bytes = SVAL(cli_req->inbuf, bytes_offset);
768
769         /*
770          * wct_ofs is a 16-bit value plus 4, wct is a 8-bit value, num_bytes
771          * is a 16-bit value. So bytes_offset being size_t should be far from
772          * wrapping.
773          */
774
775         if ((bytes_offset + 2 > talloc_get_size(cli_req->inbuf))
776             || (bytes_offset > 0xffff)) {
777                 return NT_STATUS_INVALID_NETWORK_RESPONSE;
778         }
779
780         *pwct = wct;
781         *pvwv = (uint16_t *)(cli_req->inbuf + wct_ofs + 1);
782         *pnum_bytes = num_bytes;
783         *pbytes = (uint8_t *)cli_req->inbuf + bytes_offset + 2;
784
785         return NT_STATUS_OK;
786 }
787
788 /**
789  * Decrypt a PDU, check the signature
790  * @param[in] cli       The cli_state that received something
791  * @param[in] pdu       The incoming bytes
792  * @retval error code
793  */
794
795
796 static NTSTATUS validate_smb_crypto(struct cli_state *cli, char *pdu)
797 {
798         NTSTATUS status;
799
800         if ((IVAL(pdu, 4) != 0x424d53ff) /* 0xFF"SMB" */
801             && (SVAL(pdu, 4) != 0x45ff)) /* 0xFF"E" */ {
802                 DEBUG(10, ("Got non-SMB PDU\n"));
803                 return NT_STATUS_INVALID_NETWORK_RESPONSE;
804         }
805
806         if (cli_encryption_on(cli) && CVAL(pdu, 0) == 0) {
807                 uint16_t enc_ctx_num;
808
809                 status = get_enc_ctx_num((uint8_t *)pdu, &enc_ctx_num);
810                 if (!NT_STATUS_IS_OK(status)) {
811                         DEBUG(10, ("get_enc_ctx_num returned %s\n",
812                                    nt_errstr(status)));
813                         return status;
814                 }
815
816                 if (enc_ctx_num != cli->trans_enc_state->enc_ctx_num) {
817                         DEBUG(10, ("wrong enc_ctx %d, expected %d\n",
818                                    enc_ctx_num,
819                                    cli->trans_enc_state->enc_ctx_num));
820                         return NT_STATUS_INVALID_HANDLE;
821                 }
822
823                 status = common_decrypt_buffer(cli->trans_enc_state, pdu);
824                 if (!NT_STATUS_IS_OK(status)) {
825                         DEBUG(10, ("common_decrypt_buffer returned %s\n",
826                                    nt_errstr(status)));
827                         return status;
828                 }
829         }
830
831         if (!cli_check_sign_mac(cli, pdu)) {
832                 DEBUG(10, ("cli_check_sign_mac failed\n"));
833                 return NT_STATUS_ACCESS_DENIED;
834         }
835
836         return NT_STATUS_OK;
837 }
838
839 /**
840  * A PDU has arrived on cli->evt_inbuf
841  * @param[in] cli       The cli_state that received something
842  */
843
844 static void handle_incoming_pdu(struct cli_state *cli)
845 {
846         struct cli_request *req;
847         uint16_t mid;
848         size_t raw_pdu_len, buf_len, pdu_len, rest_len;
849         char *pdu;
850         int i;
851         NTSTATUS status;
852
853         int num_async;
854
855         /*
856          * The encrypted PDU len might differ from the unencrypted one
857          */
858         raw_pdu_len = smb_len(cli->evt_inbuf) + 4;
859         buf_len = talloc_get_size(cli->evt_inbuf);
860         rest_len = buf_len - raw_pdu_len;
861
862         if (buf_len == raw_pdu_len) {
863                 /*
864                  * Optimal case: Exactly one PDU was in the socket buffer
865                  */
866                 pdu = cli->evt_inbuf;
867                 cli->evt_inbuf = NULL;
868         }
869         else {
870                 DEBUG(11, ("buf_len = %d, raw_pdu_len = %d, splitting "
871                            "buffer\n", (int)buf_len, (int)raw_pdu_len));
872
873                 if (raw_pdu_len < rest_len) {
874                         /*
875                          * The PDU is shorter, talloc_memdup that one.
876                          */
877                         pdu = (char *)talloc_memdup(
878                                 cli, cli->evt_inbuf, raw_pdu_len);
879
880                         memmove(cli->evt_inbuf, cli->evt_inbuf + raw_pdu_len,
881                                 buf_len - raw_pdu_len);
882
883                         cli->evt_inbuf = TALLOC_REALLOC_ARRAY(
884                                 NULL, cli->evt_inbuf, char, rest_len);
885
886                         if (pdu == NULL) {
887                                 status = NT_STATUS_NO_MEMORY;
888                                 goto invalidate_requests;
889                         }
890                 }
891                 else {
892                         /*
893                          * The PDU is larger than the rest, talloc_memdup the
894                          * rest
895                          */
896                         pdu = cli->evt_inbuf;
897
898                         cli->evt_inbuf = (char *)talloc_memdup(
899                                 cli, pdu + raw_pdu_len, rest_len);
900
901                         if (cli->evt_inbuf == NULL) {
902                                 status = NT_STATUS_NO_MEMORY;
903                                 goto invalidate_requests;
904                         }
905                 }
906         }
907
908         status = validate_smb_crypto(cli, pdu);
909         if (!NT_STATUS_IS_OK(status)) {
910                 goto invalidate_requests;
911         }
912
913         mid = SVAL(pdu, smb_mid);
914
915         DEBUG(10, ("handle_incoming_pdu: got mid %d\n", mid));
916
917         for (req = cli->outstanding_requests; req; req = req->next) {
918                 if (req->mid == mid) {
919                         break;
920                 }
921         }
922
923         pdu_len = smb_len(pdu) + 4;
924
925         if (req == NULL) {
926                 DEBUG(3, ("Request for mid %d not found, dumping PDU\n", mid));
927
928                 TALLOC_FREE(pdu);
929                 return;
930         }
931
932         req->inbuf = talloc_move(req, &pdu);
933
934         /*
935          * Freeing the last async_req will free the req (see
936          * cli_async_req_destructor). So make a copy of req->num_async, we
937          * can't reference it in the last round.
938          */
939
940         num_async = req->num_async;
941
942         for (i=0; i<num_async; i++) {
943                 /**
944                  * A request might have been talloc_free()'ed before we arrive
945                  * here. It will have removed itself from req->async via its
946                  * destructor cli_async_req_destructor().
947                  */
948                 if (req->async[i] != NULL) {
949                         if (req->recv_helper.fn != NULL) {
950                                 req->recv_helper.fn(req->async[i]);
951                         } else {
952                                 async_req_done(req->async[i]);
953                         }
954                 }
955         }
956         return;
957
958  invalidate_requests:
959
960         DEBUG(10, ("handle_incoming_pdu: Aborting with %s\n",
961                    nt_errstr(status)));
962
963         for (req = cli->outstanding_requests; req; req = req->next) {
964                 async_req_error(req->async[0], status);
965         }
966         return;
967 }
968
969 /**
970  * fd event callback. This is the basic connection to the socket
971  * @param[in] event_ctx The event context that called us
972  * @param[in] event     The event that fired
973  * @param[in] flags     EVENT_FD_READ | EVENT_FD_WRITE
974  * @param[in] p         private_data, in this case the cli_state
975  */
976
977 static void cli_state_handler(struct event_context *event_ctx,
978                               struct fd_event *event, uint16 flags, void *p)
979 {
980         struct cli_state *cli = (struct cli_state *)p;
981         struct cli_request *req;
982         NTSTATUS status;
983
984         DEBUG(11, ("cli_state_handler called with flags %d\n", flags));
985
986         if (flags & EVENT_FD_WRITE) {
987                 size_t to_send;
988                 ssize_t sent;
989
990                 for (req = cli->outstanding_requests; req; req = req->next) {
991                         to_send = smb_len(req->outbuf)+4;
992                         if (to_send > req->sent) {
993                                 break;
994                         }
995                 }
996
997                 if (req == NULL) {
998                         if (cli->fd_event != NULL) {
999                                 event_fd_set_not_writeable(cli->fd_event);
1000                         }
1001                         return;
1002                 }
1003
1004                 sent = sys_send(cli->fd, req->outbuf + req->sent,
1005                             to_send - req->sent, 0);
1006
1007                 if (sent < 0) {
1008                         status = map_nt_error_from_unix(errno);
1009                         goto sock_error;
1010                 }
1011
1012                 req->sent += sent;
1013
1014                 if (req->sent == to_send) {
1015                         return;
1016                 }
1017         }
1018
1019         if (flags & EVENT_FD_READ) {
1020                 int res, available;
1021                 size_t old_size, new_size;
1022                 char *tmp;
1023
1024                 res = ioctl(cli->fd, FIONREAD, &available);
1025                 if (res == -1) {
1026                         DEBUG(10, ("ioctl(FIONREAD) failed: %s\n",
1027                                    strerror(errno)));
1028                         status = map_nt_error_from_unix(errno);
1029                         goto sock_error;
1030                 }
1031
1032                 if (available == 0) {
1033                         /* EOF */
1034                         status = NT_STATUS_END_OF_FILE;
1035                         goto sock_error;
1036                 }
1037
1038                 old_size = talloc_get_size(cli->evt_inbuf);
1039                 new_size = old_size + available;
1040
1041                 if (new_size < old_size) {
1042                         /* wrap */
1043                         status = NT_STATUS_UNEXPECTED_IO_ERROR;
1044                         goto sock_error;
1045                 }
1046
1047                 tmp = TALLOC_REALLOC_ARRAY(cli, cli->evt_inbuf, char,
1048                                            new_size);
1049                 if (tmp == NULL) {
1050                         /* nomem */
1051                         status = NT_STATUS_NO_MEMORY;
1052                         goto sock_error;
1053                 }
1054                 cli->evt_inbuf = tmp;
1055
1056                 res = sys_recv(cli->fd, cli->evt_inbuf + old_size, available, 0);
1057                 if (res == -1) {
1058                         DEBUG(10, ("recv failed: %s\n", strerror(errno)));
1059                         status = map_nt_error_from_unix(errno);
1060                         goto sock_error;
1061                 }
1062
1063                 DEBUG(11, ("cli_state_handler: received %d bytes, "
1064                            "smb_len(evt_inbuf) = %d\n", (int)res,
1065                            smb_len(cli->evt_inbuf)));
1066
1067                 /* recv *might* have returned less than announced */
1068                 new_size = old_size + res;
1069
1070                 /* shrink, so I don't expect errors here */
1071                 cli->evt_inbuf = TALLOC_REALLOC_ARRAY(cli, cli->evt_inbuf,
1072                                                       char, new_size);
1073
1074                 while ((cli->evt_inbuf != NULL)
1075                        && ((smb_len(cli->evt_inbuf) + 4) <= new_size)) {
1076                         /*
1077                          * we've got a complete NBT level PDU in evt_inbuf
1078                          */
1079                         handle_incoming_pdu(cli);
1080                         new_size = talloc_get_size(cli->evt_inbuf);
1081                 }
1082         }
1083
1084         return;
1085
1086  sock_error:
1087         for (req = cli->outstanding_requests; req; req = req->next) {
1088                 int i;
1089                 for (i=0; i<req->num_async; i++) {
1090                         async_req_error(req->async[i], status);
1091                 }
1092         }
1093         TALLOC_FREE(cli->fd_event);
1094         close(cli->fd);
1095         cli->fd = -1;
1096 }