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