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);
 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         size_t smblen;
 556
 557         SMB_ASSERT(req != NULL);
 558
 559         DLIST_ADD_END(cli->outstanding_requests, req, struct cli_request *);
 560         talloc_set_destructor(req, cli_request_destructor);
 561
 562         cli->chain_accumulator = NULL;
 563
 564         SSVAL(req->outbuf, smb_mid, req->mid);
 565
 566         smblen = talloc_get_size(req->outbuf) - 4;
 567
 568         smb_setlen((char *)req->outbuf, smblen);
 569
 570         if (smblen > 0x1ffff) {
 571                 /*
 572                  * This is a POSIX 14 word large write. Overwrite just the
 573                  * size field, the '0xFFSMB' has been set by smb_setlen which
 574                  * _smb_setlen_large does not do.
 575                  */
 576                 _smb_setlen_large(((char *)req->outbuf), smblen);
 577         }
 578
 579         cli_calculate_sign_mac(cli, (char *)req->outbuf);
 580
 581         if (cli_encryption_on(cli)) {
 582                 NTSTATUS status;
 583                 char *enc_buf;
 584
 585                 status = cli_encrypt_message(cli, (char *)req->outbuf,
 586                                              &enc_buf);
 587                 if (!NT_STATUS_IS_OK(status)) {
 588                         DEBUG(0, ("Error in encrypting client message. "
 589                                   "Error %s\n", nt_errstr(status)));
 590                         TALLOC_FREE(req);
 591                         return;
 592                 }
 593                 req->outbuf = (uint8_t *)enc_buf;
 594                 req->enc_state = cli->trans_enc_state;
 595         }
 596
 597         req->sent = 0;
 598
 599         event_fd_set_writeable(cli->fd_event);
 600 }
 601
 602 /**
 603  * @brief Send a request to the server
 604  * @param[in] mem_ctx           The TALLOC_CTX for the result
 605  * @param[in] ev                The event context that will call us back
 606  * @param[in] cli               The cli_state we queue the request up for
 607  * @param[in] smb_command       The command that we want to issue
 608  * @param[in] additional_flags  open_and_x wants to add oplock header flags
 609  * @param[in] wct               How many words?
 610  * @param[in] vwv               The words, already in network order
 611  * @param[in] bytes_alignment   How shall we align "bytes"?
 612  * @param[in] num_bytes         How many bytes?
 613  * @param[in] bytes             The data the request ships
 614  *
 615  * This is the generic routine to be used by the cli_xxx_send routines.
 616  */
 617
 618 struct async_req *cli_request_send(TALLOC_CTX *mem_ctx,
 619                                    struct event_context *ev,
 620                                    struct cli_state *cli,
 621                                    uint8_t smb_command,
 622                                    uint8_t additional_flags,
 623                                    uint8_t wct, const uint16_t *vwv,
 624                                    size_t bytes_alignment,
 625                                    uint32_t num_bytes, const uint8_t *bytes)
 626 {
 627         struct async_req *result;
 628         bool uncork = false;
 629
 630         if (cli->chain_accumulator == NULL) {
 631                 if (!cli_chain_cork(cli, ev,
 632                                     wct * sizeof(uint16_t) + num_bytes + 3)) {
 633                         DEBUG(1, ("cli_chain_cork failed\n"));
 634                         return NULL;
 635                 }
 636                 uncork = true;
 637         }
 638
 639         result = cli_request_chain(mem_ctx, ev, cli, smb_command,
 640                                    additional_flags, wct, vwv, bytes_alignment,
 641                                    num_bytes, bytes);
 642
 643         if (result == NULL) {
 644                 DEBUG(1, ("cli_request_chain failed\n"));
 645         }
 646
 647         if (uncork) {
 648                 cli_chain_uncork(cli);
 649         }
 650
 651         return result;
 652 }
 653
 654 /**
 655  * Calculate the current ofs to wct for requests like write&x
 656  * @param[in] req       The smb request we're currently building
 657  * @retval how many bytes offset have we accumulated?
 658  */
 659
 660 uint16_t cli_wct_ofs(const struct cli_state *cli)
 661 {
 662         size_t buf_size;
 663
 664         if (cli->chain_accumulator == NULL) {
 665                 return smb_wct - 4;
 666         }
 667
 668         buf_size = talloc_get_size(cli->chain_accumulator->outbuf);
 669
 670         if (buf_size == smb_wct) {
 671                 return smb_wct - 4;
 672         }
 673
 674         /*
 675          * Add alignment for subsequent requests
 676          */
 677
 678         if ((buf_size % 4) != 0) {
 679                 buf_size += (4 - (buf_size % 4));
 680         }
 681
 682         return buf_size - 4;
 683 }
 684
 685 /**
 686  * Figure out if there is an andx command behind the current one
 687  * @param[in] buf       The smb buffer to look at
 688  * @param[in] ofs       The offset to the wct field that is followed by the cmd
 689  * @retval Is there a command following?
 690  */
 691
 692 static bool have_andx_command(const char *buf, uint16_t ofs)
 693 {
 694         uint8_t wct;
 695         size_t buflen = talloc_get_size(buf);
 696
 697         if ((ofs == buflen-1) || (ofs == buflen)) {
 698                 return false;
 699         }
 700
 701         wct = CVAL(buf, ofs);
 702         if (wct < 2) {
 703                 /*
 704                  * Not enough space for the command and a following pointer
 705                  */
 706                 return false;
 707         }
 708         return (CVAL(buf, ofs+1) != 0xff);
 709 }
 710
 711 /**
 712  * @brief Pull reply data out of a request
 713  * @param[in] req               The request that we just received a reply for
 714  * @param[out] pwct             How many words did the server send?
 715  * @param[out] pvwv             The words themselves
 716  * @param[out] pnum_bytes       How many bytes did the server send?
 717  * @param[out] pbytes           The bytes themselves
 718  * @retval Was the reply formally correct?
 719  */
 720
 721 NTSTATUS cli_pull_reply(struct async_req *req,
 722                         uint8_t *pwct, uint16_t **pvwv,
 723                         uint16_t *pnum_bytes, uint8_t **pbytes)
 724 {
 725         struct cli_request *cli_req = talloc_get_type_abort(
 726                 req->private_data, struct cli_request);
 727         uint8_t wct, cmd;
 728         uint16_t num_bytes;
 729         size_t wct_ofs, bytes_offset;
 730         int i, j;
 731         NTSTATUS status;
 732
 733         for (i = 0; i < cli_req->num_async; i++) {
 734                 if (req == cli_req->async[i]) {
 735                         break;
 736                 }
 737         }
 738
 739         if (i == cli_req->num_async) {
 740                 cli_set_error(cli_req->cli, NT_STATUS_INVALID_PARAMETER);
 741                 return NT_STATUS_INVALID_PARAMETER;
 742         }
 743
 744         /**
 745          * The status we pull here is only relevant for the last reply in the
 746          * chain.
 747          */
 748
 749         status = cli_pull_error(cli_req->inbuf);
 750
 751         if (i == 0) {
 752                 if (NT_STATUS_IS_ERR(status)
 753                     && !have_andx_command(cli_req->inbuf, smb_wct)) {
 754                         cli_set_error(cli_req->cli, status);
 755                         return status;
 756                 }
 757                 wct_ofs = smb_wct;
 758                 goto done;
 759         }
 760
 761         cmd = CVAL(cli_req->inbuf, smb_com);
 762         wct_ofs = smb_wct;
 763
 764         for (j = 0; j < i; j++) {
 765                 if (j < i-1) {
 766                         if (cmd == 0xff) {
 767                                 return NT_STATUS_REQUEST_ABORTED;
 768                         }
 769                         if (!is_andx_req(cmd)) {
 770                                 return NT_STATUS_INVALID_NETWORK_RESPONSE;
 771                         }
 772                 }
 773
 774                 if (!have_andx_command(cli_req->inbuf, wct_ofs)) {
 775                         /*
 776                          * This request was not completed because a previous
 777                          * request in the chain had received an error.
 778                          */
 779                         return NT_STATUS_REQUEST_ABORTED;
 780                 }
 781
 782                 wct_ofs = SVAL(cli_req->inbuf, wct_ofs + 3);
 783
 784                 /*
 785                  * Skip the all-present length field. No overflow, we've just
 786                  * put a 16-bit value into a size_t.
 787                  */
 788                 wct_ofs += 4;
 789
 790                 if (wct_ofs+2 > talloc_get_size(cli_req->inbuf)) {
 791                         return NT_STATUS_INVALID_NETWORK_RESPONSE;
 792                 }
 793
 794                 cmd = CVAL(cli_req->inbuf, wct_ofs + 1);
 795         }
 796
 797         if (!have_andx_command(cli_req->inbuf, wct_ofs)
 798             && NT_STATUS_IS_ERR(status)) {
 799                 /*
 800                  * The last command takes the error code. All further commands
 801                  * down the requested chain will get a
 802                  * NT_STATUS_REQUEST_ABORTED.
 803                  */
 804                 return status;
 805         }
 806
 807  done:
 808         wct = CVAL(cli_req->inbuf, wct_ofs);
 809
 810         bytes_offset = wct_ofs + 1 + wct * sizeof(uint16_t);
 811         num_bytes = SVAL(cli_req->inbuf, bytes_offset);
 812
 813         /*
 814          * wct_ofs is a 16-bit value plus 4, wct is a 8-bit value, num_bytes
 815          * is a 16-bit value. So bytes_offset being size_t should be far from
 816          * wrapping.
 817          */
 818
 819         if ((bytes_offset + 2 > talloc_get_size(cli_req->inbuf))
 820             || (bytes_offset > 0xffff)) {
 821                 return NT_STATUS_INVALID_NETWORK_RESPONSE;
 822         }
 823
 824         *pwct = wct;
 825         *pvwv = (uint16_t *)(cli_req->inbuf + wct_ofs + 1);
 826         *pnum_bytes = num_bytes;
 827         *pbytes = (uint8_t *)cli_req->inbuf + bytes_offset + 2;
 828
 829         return NT_STATUS_OK;
 830 }
 831
 832 /**
 833  * Decrypt a PDU, check the signature
 834  * @param[in] cli       The cli_state that received something
 835  * @param[in] pdu       The incoming bytes
 836  * @retval error code
 837  */
 838
 839
 840 static NTSTATUS validate_smb_crypto(struct cli_state *cli, char *pdu)
 841 {
 842         NTSTATUS status;
 843
 844         if ((IVAL(pdu, 4) != 0x424d53ff) /* 0xFF"SMB" */
 845             && (SVAL(pdu, 4) != 0x45ff)) /* 0xFF"E" */ {
 846                 DEBUG(10, ("Got non-SMB PDU\n"));
 847                 return NT_STATUS_INVALID_NETWORK_RESPONSE;
 848         }
 849
 850         if (cli_encryption_on(cli) && CVAL(pdu, 0) == 0) {
 851                 uint16_t enc_ctx_num;
 852
 853                 status = get_enc_ctx_num((uint8_t *)pdu, &enc_ctx_num);
 854                 if (!NT_STATUS_IS_OK(status)) {
 855                         DEBUG(10, ("get_enc_ctx_num returned %s\n",
 856                                    nt_errstr(status)));
 857                         return status;
 858                 }
 859
 860                 if (enc_ctx_num != cli->trans_enc_state->enc_ctx_num) {
 861                         DEBUG(10, ("wrong enc_ctx %d, expected %d\n",
 862                                    enc_ctx_num,
 863                                    cli->trans_enc_state->enc_ctx_num));
 864                         return NT_STATUS_INVALID_HANDLE;
 865                 }
 866
 867                 status = common_decrypt_buffer(cli->trans_enc_state, pdu);
 868                 if (!NT_STATUS_IS_OK(status)) {
 869                         DEBUG(10, ("common_decrypt_buffer returned %s\n",
 870                                    nt_errstr(status)));
 871                         return status;
 872                 }
 873         }
 874
 875         if (!cli_check_sign_mac(cli, pdu)) {
 876                 DEBUG(10, ("cli_check_sign_mac failed\n"));
 877                 return NT_STATUS_ACCESS_DENIED;
 878         }
 879
 880         return NT_STATUS_OK;
 881 }
 882
 883 /**
 884  * A PDU has arrived on cli->evt_inbuf
 885  * @param[in] cli       The cli_state that received something
 886  */
 887
 888 static void handle_incoming_pdu(struct cli_state *cli)
 889 {
 890         struct cli_request *req;
 891         uint16_t mid;
 892         size_t raw_pdu_len, buf_len, pdu_len, rest_len;
 893         char *pdu;
 894         int i;
 895         NTSTATUS status;
 896
 897         int num_async;
 898
 899         /*
 900          * The encrypted PDU len might differ from the unencrypted one
 901          */
 902         raw_pdu_len = smb_len(cli->evt_inbuf) + 4;
 903         buf_len = talloc_get_size(cli->evt_inbuf);
 904         rest_len = buf_len - raw_pdu_len;
 905
 906         if (buf_len == raw_pdu_len) {
 907                 /*
 908                  * Optimal case: Exactly one PDU was in the socket buffer
 909                  */
 910                 pdu = cli->evt_inbuf;
 911                 cli->evt_inbuf = NULL;
 912         }
 913         else {
 914                 DEBUG(11, ("buf_len = %d, raw_pdu_len = %d, splitting "
 915                            "buffer\n", (int)buf_len, (int)raw_pdu_len));
 916
 917                 if (raw_pdu_len < rest_len) {
 918                         /*
 919                          * The PDU is shorter, talloc_memdup that one.
 920                          */
 921                         pdu = (char *)talloc_memdup(
 922                                 cli, cli->evt_inbuf, raw_pdu_len);
 923
 924                         memmove(cli->evt_inbuf, cli->evt_inbuf + raw_pdu_len,
 925                                 buf_len - raw_pdu_len);
 926
 927                         cli->evt_inbuf = TALLOC_REALLOC_ARRAY(
 928                                 NULL, cli->evt_inbuf, char, rest_len);
 929
 930                         if (pdu == NULL) {
 931                                 status = NT_STATUS_NO_MEMORY;
 932                                 goto invalidate_requests;
 933                         }
 934                 }
 935                 else {
 936                         /*
 937                          * The PDU is larger than the rest, talloc_memdup the
 938                          * rest
 939                          */
 940                         pdu = cli->evt_inbuf;
 941
 942                         cli->evt_inbuf = (char *)talloc_memdup(
 943                                 cli, pdu + raw_pdu_len, rest_len);
 944
 945                         if (cli->evt_inbuf == NULL) {
 946                                 status = NT_STATUS_NO_MEMORY;
 947                                 goto invalidate_requests;
 948                         }
 949                 }
 950         }
 951
 952         status = validate_smb_crypto(cli, pdu);
 953         if (!NT_STATUS_IS_OK(status)) {
 954                 goto invalidate_requests;
 955         }
 956
 957         mid = SVAL(pdu, smb_mid);
 958
 959         DEBUG(10, ("handle_incoming_pdu: got mid %d\n", mid));
 960
 961         for (req = cli->outstanding_requests; req; req = req->next) {
 962                 if (req->mid == mid) {
 963                         break;
 964                 }
 965         }
 966
 967         pdu_len = smb_len(pdu) + 4;
 968
 969         if (req == NULL) {
 970                 DEBUG(3, ("Request for mid %d not found, dumping PDU\n", mid));
 971
 972                 TALLOC_FREE(pdu);
 973                 return;
 974         }
 975
 976         req->inbuf = talloc_move(req, &pdu);
 977
 978         /*
 979          * Freeing the last async_req will free the req (see
 980          * cli_async_req_destructor). So make a copy of req->num_async, we
 981          * can't reference it in the last round.
 982          */
 983
 984         num_async = req->num_async;
 985
 986         for (i=0; i<num_async; i++) {
 987                 /**
 988                  * A request might have been talloc_free()'ed before we arrive
 989                  * here. It will have removed itself from req->async via its
 990                  * destructor cli_async_req_destructor().
 991                  */
 992                 if (req->async[i] != NULL) {
 993                         if (req->recv_helper.fn != NULL) {
 994                                 req->recv_helper.fn(req->async[i]);
 995                         } else {
 996                                 async_req_done(req->async[i]);
 997                         }
 998                 }
 999         }
1000         return;
1001
1002  invalidate_requests:
1003
1004         DEBUG(10, ("handle_incoming_pdu: Aborting with %s\n",
1005                    nt_errstr(status)));
1006
1007         for (req = cli->outstanding_requests; req; req = req->next) {
1008                 async_req_error(req->async[0], status);
1009         }
1010         return;
1011 }
1012
1013 /**
1014  * fd event callback. This is the basic connection to the socket
1015  * @param[in] event_ctx The event context that called us
1016  * @param[in] event     The event that fired
1017  * @param[in] flags     EVENT_FD_READ | EVENT_FD_WRITE
1018  * @param[in] p         private_data, in this case the cli_state
1019  */
1020
1021 static void cli_state_handler(struct event_context *event_ctx,
1022                               struct fd_event *event, uint16 flags, void *p)
1023 {
1024         struct cli_state *cli = (struct cli_state *)p;
1025         struct cli_request *req;
1026         NTSTATUS status;
1027
1028         DEBUG(11, ("cli_state_handler called with flags %d\n", flags));
1029
1030         if (flags & EVENT_FD_WRITE) {
1031                 size_t to_send;
1032                 ssize_t sent;
1033
1034                 for (req = cli->outstanding_requests; req; req = req->next) {
1035                         to_send = smb_len(req->outbuf)+4;
1036                         if (to_send > req->sent) {
1037                                 break;
1038                         }
1039                 }
1040
1041                 if (req == NULL) {
1042                         if (cli->fd_event != NULL) {
1043                                 event_fd_set_not_writeable(cli->fd_event);
1044                         }
1045                         return;
1046                 }
1047
1048                 sent = sys_send(cli->fd, req->outbuf + req->sent,
1049                             to_send - req->sent, 0);
1050
1051                 if (sent < 0) {
1052                         status = map_nt_error_from_unix(errno);
1053                         goto sock_error;
1054                 }
1055
1056                 req->sent += sent;
1057
1058                 if (req->sent == to_send) {
1059                         return;
1060                 }
1061         }
1062
1063         if (flags & EVENT_FD_READ) {
1064                 int res, available;
1065                 size_t old_size, new_size;
1066                 char *tmp;
1067
1068                 res = ioctl(cli->fd, FIONREAD, &available);
1069                 if (res == -1) {
1070                         DEBUG(10, ("ioctl(FIONREAD) failed: %s\n",
1071                                    strerror(errno)));
1072                         status = map_nt_error_from_unix(errno);
1073                         goto sock_error;
1074                 }
1075
1076                 if (available == 0) {
1077                         /* EOF */
1078                         status = NT_STATUS_END_OF_FILE;
1079                         goto sock_error;
1080                 }
1081
1082                 old_size = talloc_get_size(cli->evt_inbuf);
1083                 new_size = old_size + available;
1084
1085                 if (new_size < old_size) {
1086                         /* wrap */
1087                         status = NT_STATUS_UNEXPECTED_IO_ERROR;
1088                         goto sock_error;
1089                 }
1090
1091                 tmp = TALLOC_REALLOC_ARRAY(cli, cli->evt_inbuf, char,
1092                                            new_size);
1093                 if (tmp == NULL) {
1094                         /* nomem */
1095                         status = NT_STATUS_NO_MEMORY;
1096                         goto sock_error;
1097                 }
1098                 cli->evt_inbuf = tmp;
1099
1100                 res = sys_recv(cli->fd, cli->evt_inbuf + old_size, available, 0);
1101                 if (res == -1) {
1102                         DEBUG(10, ("recv failed: %s\n", strerror(errno)));
1103                         status = map_nt_error_from_unix(errno);
1104                         goto sock_error;
1105                 }
1106
1107                 DEBUG(11, ("cli_state_handler: received %d bytes, "
1108                            "smb_len(evt_inbuf) = %d\n", (int)res,
1109                            smb_len(cli->evt_inbuf)));
1110
1111                 /* recv *might* have returned less than announced */
1112                 new_size = old_size + res;
1113
1114                 /* shrink, so I don't expect errors here */
1115                 cli->evt_inbuf = TALLOC_REALLOC_ARRAY(cli, cli->evt_inbuf,
1116                                                       char, new_size);
1117
1118                 while ((cli->evt_inbuf != NULL)
1119                        && ((smb_len(cli->evt_inbuf) + 4) <= new_size)) {
1120                         /*
1121                          * we've got a complete NBT level PDU in evt_inbuf
1122                          */
1123                         handle_incoming_pdu(cli);
1124                         new_size = talloc_get_size(cli->evt_inbuf);
1125                 }
1126         }
1127
1128         return;
1129
1130  sock_error:
1131         for (req = cli->outstanding_requests; req; req = req->next) {
1132                 int i;
1133                 for (i=0; i<req->num_async; i++) {
1134                         async_req_error(req->async[i], status);
1135                 }
1136         }
1137         TALLOC_FREE(cli->fd_event);
1138         close(cli->fd);
1139         cli->fd = -1;
1140 }