source3/libsmb/clientgen.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB client generic functions
   4    Copyright (C) Andrew Tridgell 1994-1998
   5    Copyright (C) Jeremy Allison 2007.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "includes.h"
  22 #include "libsmb/libsmb.h"
  23 #include "../lib/util/tevent_ntstatus.h"
  24 #include "smb_signing.h"
  25 #include "async_smb.h"
  26
  27 /*******************************************************************
  28  Setup the word count and byte count for a client smb message.
  29 ********************************************************************/
  30
  31 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
  32 {
  33         if (zero && (num_words || num_bytes)) {
  34                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
  35         }
  36         SCVAL(buf,smb_wct,num_words);
  37         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
  38         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
  39         return (smb_size + num_words*2 + num_bytes);
  40 }
  41
  42 /****************************************************************************
  43  Change the timeout (in milliseconds).
  44 ****************************************************************************/
  45
  46 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
  47 {
  48         unsigned int old_timeout = cli->timeout;
  49         cli->timeout = timeout;
  50         return old_timeout;
  51 }
  52
  53 /****************************************************************************
  54  Change the port number used to call on.
  55 ****************************************************************************/
  56
  57 void cli_set_port(struct cli_state *cli, int port)
  58 {
  59         cli->port = port;
  60 }
  61
  62 /****************************************************************************
  63  convenience routine to find if we negotiated ucs2
  64 ****************************************************************************/
  65
  66 bool cli_ucs2(struct cli_state *cli)
  67 {
  68         return ((cli->capabilities & CAP_UNICODE) != 0);
  69 }
  70
  71
  72 /****************************************************************************
  73  Read an smb from a fd ignoring all keepalive packets.
  74  The timeout is in milliseconds
  75
  76  This is exactly the same as receive_smb except that it never returns
  77  a session keepalive packet (just as receive_smb used to do).
  78  receive_smb was changed to return keepalives as the oplock processing means this call
  79  should never go into a blocking read.
  80 ****************************************************************************/
  81
  82 static ssize_t client_receive_smb(struct cli_state *cli, size_t maxlen)
  83 {
  84         size_t len;
  85
  86         for(;;) {
  87                 NTSTATUS status;
  88
  89                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
  90
  91                 status = receive_smb_raw(cli->fd, cli->inbuf, cli->bufsize,
  92                                         cli->timeout, maxlen, &len);
  93                 if (!NT_STATUS_IS_OK(status)) {
  94                         DEBUG(10,("client_receive_smb failed\n"));
  95                         show_msg(cli->inbuf);
  96
  97                         if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
  98                                 set_smb_read_error(&cli->smb_rw_error,
  99                                                    SMB_READ_EOF);
 100                                 return -1;
 101                         }
 102
 103                         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
 104                                 set_smb_read_error(&cli->smb_rw_error,
 105                                                    SMB_READ_TIMEOUT);
 106                                 return -1;
 107                         }
 108
 109                         set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
 110                         return -1;
 111                 }
 112
 113                 /*
 114                  * I don't believe len can be < 0 with NT_STATUS_OK
 115                  * returned above, but this check doesn't hurt. JRA.
 116                  */
 117
 118                 if ((ssize_t)len < 0) {
 119                         return len;
 120                 }
 121
 122                 /* Ignore session keepalive packets. */
 123                 if(CVAL(cli->inbuf,0) != SMBkeepalive) {
 124                         break;
 125                 }
 126         }
 127
 128         if (cli_encryption_on(cli)) {
 129                 NTSTATUS status = cli_decrypt_message(cli);
 130                 if (!NT_STATUS_IS_OK(status)) {
 131                         DEBUG(0, ("SMB decryption failed on incoming packet! Error %s\n",
 132                                 nt_errstr(status)));
 133                         cli->smb_rw_error = SMB_READ_BAD_DECRYPT;
 134                         return -1;
 135                 }
 136         }
 137
 138         show_msg(cli->inbuf);
 139         return len;
 140 }
 141
 142 static bool cli_state_set_seqnum(struct cli_state *cli, uint16_t mid, uint32_t seqnum)
 143 {
 144         struct cli_state_seqnum *c;
 145
 146         for (c = cli->seqnum; c; c = c->next) {
 147                 if (c->mid == mid) {
 148                         c->seqnum = seqnum;
 149                         return true;
 150                 }
 151         }
 152
 153         c = talloc_zero(cli, struct cli_state_seqnum);
 154         if (!c) {
 155                 return false;
 156         }
 157
 158         c->mid = mid;
 159         c->seqnum = seqnum;
 160         c->persistent = false;
 161         DLIST_ADD_END(cli->seqnum, c, struct cli_state_seqnum *);
 162
 163         return true;
 164 }
 165
 166 bool cli_state_seqnum_persistent(struct cli_state *cli,
 167                                  uint16_t mid)
 168 {
 169         struct cli_state_seqnum *c;
 170
 171         for (c = cli->seqnum; c; c = c->next) {
 172                 if (c->mid == mid) {
 173                         c->persistent = true;
 174                         return true;
 175                 }
 176         }
 177
 178         return false;
 179 }
 180
 181 bool cli_state_seqnum_remove(struct cli_state *cli,
 182                              uint16_t mid)
 183 {
 184         struct cli_state_seqnum *c;
 185
 186         for (c = cli->seqnum; c; c = c->next) {
 187                 if (c->mid == mid) {
 188                         DLIST_REMOVE(cli->seqnum, c);
 189                         TALLOC_FREE(c);
 190                         return true;
 191                 }
 192         }
 193
 194         return false;
 195 }
 196
 197 static uint32_t cli_state_get_seqnum(struct cli_state *cli, uint16_t mid)
 198 {
 199         struct cli_state_seqnum *c;
 200
 201         for (c = cli->seqnum; c; c = c->next) {
 202                 if (c->mid == mid) {
 203                         uint32_t seqnum = c->seqnum;
 204                         if (!c->persistent) {
 205                                 DLIST_REMOVE(cli->seqnum, c);
 206                                 TALLOC_FREE(c);
 207                         }
 208                         return seqnum;
 209                 }
 210         }
 211
 212         return 0;
 213 }
 214
 215 /****************************************************************************
 216  Recv an smb.
 217 ****************************************************************************/
 218
 219 bool cli_receive_smb(struct cli_state *cli)
 220 {
 221         ssize_t len;
 222         uint16_t mid;
 223         uint32_t seqnum;
 224
 225         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
 226         if (cli->fd == -1)
 227                 return false;
 228
 229  again:
 230         len = client_receive_smb(cli, 0);
 231
 232         if (len > 0) {
 233                 /* it might be an oplock break request */
 234                 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
 235                     CVAL(cli->inbuf,smb_com) == SMBlockingX &&
 236                     SVAL(cli->inbuf,smb_vwv6) == 0 &&
 237                     SVAL(cli->inbuf,smb_vwv7) == 0) {
 238                         if (cli->oplock_handler) {
 239                                 int fnum = SVAL(cli->inbuf,smb_vwv2);
 240                                 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
 241                                 if (!NT_STATUS_IS_OK(cli->oplock_handler(cli, fnum, level))) {
 242                                         return false;
 243                                 }
 244                         }
 245                         /* try to prevent loops */
 246                         SCVAL(cli->inbuf,smb_com,0xFF);
 247                         goto again;
 248                 }
 249         }
 250
 251         /* If the server is not responding, note that now */
 252         if (len < 0) {
 253                 /*
 254                  * only log if the connection should still be open and not when
 255                  * the connection was closed due to a dropped ip message
 256                  */
 257                 if (cli->fd != -1) {
 258                         char addr[INET6_ADDRSTRLEN];
 259                         print_sockaddr(addr, sizeof(addr), &cli->dest_ss);
 260                         DEBUG(0, ("Receiving SMB: Server %s stopped responding\n",
 261                                 addr));
 262                         close(cli->fd);
 263                         cli->fd = -1;
 264                 }
 265                 return false;
 266         }
 267
 268         mid = SVAL(cli->inbuf,smb_mid);
 269         seqnum = cli_state_get_seqnum(cli, mid);
 270
 271         if (!cli_check_sign_mac(cli, cli->inbuf, seqnum+1)) {
 272                 /*
 273                  * If we get a signature failure in sessionsetup, then
 274                  * the server sometimes just reflects the sent signature
 275                  * back to us. Detect this and allow the upper layer to
 276                  * retrieve the correct Windows error message.
 277                  */
 278                 if (CVAL(cli->outbuf,smb_com) == SMBsesssetupX &&
 279                         (smb_len(cli->inbuf) > (smb_ss_field + 8 - 4)) &&
 280                         (SVAL(cli->inbuf,smb_flg2) & FLAGS2_SMB_SECURITY_SIGNATURES) &&
 281                         memcmp(&cli->outbuf[smb_ss_field],&cli->inbuf[smb_ss_field],8) == 0 &&
 282                         cli_is_error(cli)) {
 283
 284                         /*
 285                          * Reflected signature on login error.
 286                          * Set bad sig but don't close fd.
 287                          */
 288                         cli->smb_rw_error = SMB_READ_BAD_SIG;
 289                         return true;
 290                 }
 291
 292                 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
 293                 cli->smb_rw_error = SMB_READ_BAD_SIG;
 294                 close(cli->fd);
 295                 cli->fd = -1;
 296                 return false;
 297         };
 298         return true;
 299 }
 300
 301 static ssize_t write_socket(int fd, const char *buf, size_t len)
 302 {
 303         ssize_t ret=0;
 304
 305         DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
 306         ret = write_data(fd,buf,len);
 307
 308         DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
 309         if(ret <= 0)
 310                 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
 311                         (int)len, fd, strerror(errno) ));
 312
 313         return(ret);
 314 }
 315
 316 /****************************************************************************
 317  Send an smb to a fd.
 318 ****************************************************************************/
 319
 320 bool cli_send_smb(struct cli_state *cli)
 321 {
 322         size_t len;
 323         size_t nwritten=0;
 324         ssize_t ret;
 325         char *buf_out = cli->outbuf;
 326         bool enc_on = cli_encryption_on(cli);
 327         uint32_t seqnum;
 328
 329         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
 330         if (cli->fd == -1)
 331                 return false;
 332
 333         cli_calculate_sign_mac(cli, cli->outbuf, &seqnum);
 334
 335         if (!cli_state_set_seqnum(cli, cli->mid, seqnum)) {
 336                 DEBUG(0,("Failed to store mid[%u]/seqnum[%u]\n",
 337                         (unsigned int)cli->mid,
 338                         (unsigned int)seqnum));
 339                 return false;
 340         }
 341
 342         if (enc_on) {
 343                 NTSTATUS status = cli_encrypt_message(cli, cli->outbuf,
 344                                                       &buf_out);
 345                 if (!NT_STATUS_IS_OK(status)) {
 346                         close(cli->fd);
 347                         cli->fd = -1;
 348                         cli->smb_rw_error = SMB_WRITE_ERROR;
 349                         DEBUG(0,("Error in encrypting client message. Error %s\n",
 350                                 nt_errstr(status) ));
 351                         return false;
 352                 }
 353         }
 354
 355         len = smb_len(buf_out) + 4;
 356
 357         while (nwritten < len) {
 358                 ret = write_socket(cli->fd,buf_out+nwritten,len - nwritten);
 359                 if (ret <= 0) {
 360                         if (enc_on) {
 361                                 cli_free_enc_buffer(cli, buf_out);
 362                         }
 363                         close(cli->fd);
 364                         cli->fd = -1;
 365                         cli->smb_rw_error = SMB_WRITE_ERROR;
 366                         DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
 367                                 (int)len,(int)ret, strerror(errno) ));
 368                         return false;
 369                 }
 370                 nwritten += ret;
 371         }
 372
 373         if (enc_on) {
 374                 cli_free_enc_buffer(cli, buf_out);
 375         }
 376
 377         /* Increment the mid so we can tell between responses. */
 378         cli->mid++;
 379         if (!cli->mid)
 380                 cli->mid++;
 381         return true;
 382 }
 383
 384 /****************************************************************************
 385  Setup basics in a outgoing packet.
 386 ****************************************************************************/
 387
 388 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
 389 {
 390         uint16 flags2;
 391         cli->rap_error = 0;
 392         SIVAL(buf,smb_rcls,0);
 393         SSVAL(buf,smb_pid,cli->pid);
 394         memset(buf+smb_pidhigh, 0, 12);
 395         SSVAL(buf,smb_uid,cli->vuid);
 396         SSVAL(buf,smb_mid,cli->mid);
 397
 398         if (cli->protocol <= PROTOCOL_CORE) {
 399                 return;
 400         }
 401
 402         if (cli->case_sensitive) {
 403                 SCVAL(buf,smb_flg,0x0);
 404         } else {
 405                 /* Default setting, case insensitive. */
 406                 SCVAL(buf,smb_flg,0x8);
 407         }
 408         flags2 = FLAGS2_LONG_PATH_COMPONENTS;
 409         if (cli->capabilities & CAP_UNICODE)
 410                 flags2 |= FLAGS2_UNICODE_STRINGS;
 411         if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
 412                 flags2 |= FLAGS2_DFS_PATHNAMES;
 413         if (cli->capabilities & CAP_STATUS32)
 414                 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
 415         if (cli->use_spnego)
 416                 flags2 |= FLAGS2_EXTENDED_SECURITY;
 417         SSVAL(buf,smb_flg2, flags2);
 418 }
 419
 420 /****************************************************************************
 421  Setup the bcc length of the packet from a pointer to the end of the data.
 422 ****************************************************************************/
 423
 424 void cli_setup_bcc(struct cli_state *cli, void *p)
 425 {
 426         set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
 427 }
 428
 429 /****************************************************************************
 430  Initialize Domain, user or password.
 431 ****************************************************************************/
 432
 433 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
 434 {
 435         TALLOC_FREE(cli->domain);
 436         cli->domain = talloc_strdup(cli, domain ? domain : "");
 437         if (cli->domain == NULL) {
 438                 return NT_STATUS_NO_MEMORY;
 439         }
 440         return NT_STATUS_OK;
 441 }
 442
 443 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
 444 {
 445         TALLOC_FREE(cli->user_name);
 446         cli->user_name = talloc_strdup(cli, username ? username : "");
 447         if (cli->user_name == NULL) {
 448                 return NT_STATUS_NO_MEMORY;
 449         }
 450         return NT_STATUS_OK;
 451 }
 452
 453 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
 454 {
 455         TALLOC_FREE(cli->password);
 456
 457         /* Password can be NULL. */
 458         if (password) {
 459                 cli->password = talloc_strdup(cli, password);
 460                 if (cli->password == NULL) {
 461                         return NT_STATUS_NO_MEMORY;
 462                 }
 463         } else {
 464                 /* Use zero NTLMSSP hashes and session key. */
 465                 cli->password = NULL;
 466         }
 467
 468         return NT_STATUS_OK;
 469 }
 470
 471 /****************************************************************************
 472  Initialise credentials of a client structure.
 473 ****************************************************************************/
 474
 475 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
 476 {
 477         NTSTATUS status = cli_set_username(cli, username);
 478         if (!NT_STATUS_IS_OK(status)) {
 479                 return status;
 480         }
 481         status = cli_set_domain(cli, domain);
 482         if (!NT_STATUS_IS_OK(status)) {
 483                 return status;
 484         }
 485         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
 486
 487         return cli_set_password(cli, password);
 488 }
 489
 490 /****************************************************************************
 491  Initialise a client structure. Always returns a talloc'ed struct.
 492  Set the signing state (used from the command line).
 493 ****************************************************************************/
 494
 495 struct cli_state *cli_initialise_ex(int signing_state)
 496 {
 497         struct cli_state *cli = NULL;
 498         bool allow_smb_signing = false;
 499         bool mandatory_signing = false;
 500
 501         /* Check the effective uid - make sure we are not setuid */
 502         if (is_setuid_root()) {
 503                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 504                 return NULL;
 505         }
 506
 507         cli = TALLOC_ZERO_P(NULL, struct cli_state);
 508         if (!cli) {
 509                 return NULL;
 510         }
 511
 512         cli->dfs_mountpoint = talloc_strdup(cli, "");
 513         if (!cli->dfs_mountpoint) {
 514                 goto error;
 515         }
 516         cli->port = 0;
 517         cli->fd = -1;
 518         cli->cnum = -1;
 519         cli->pid = (uint16)sys_getpid();
 520         cli->mid = 1;
 521         cli->vuid = UID_FIELD_INVALID;
 522         cli->protocol = PROTOCOL_NT1;
 523         cli->timeout = 20000; /* Timeout is in milliseconds. */
 524         cli->bufsize = CLI_BUFFER_SIZE+4;
 525         cli->max_xmit = cli->bufsize;
 526         cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 527         cli->seqnum = 0;
 528         cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 529         cli->oplock_handler = cli_oplock_ack;
 530         cli->case_sensitive = false;
 531         cli->smb_rw_error = SMB_READ_OK;
 532
 533         cli->use_spnego = lp_client_use_spnego();
 534
 535         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 536
 537         /* Set the CLI_FORCE_DOSERR environment variable to test
 538            client routines using DOS errors instead of STATUS32
 539            ones.  This intended only as a temporary hack. */
 540         if (getenv("CLI_FORCE_DOSERR"))
 541                 cli->force_dos_errors = true;
 542
 543         if (lp_client_signing()) {
 544                 allow_smb_signing = true;
 545         }
 546
 547         if (lp_client_signing() == Required) {
 548                 mandatory_signing = true;
 549         }
 550
 551         if (signing_state != Undefined) {
 552                 allow_smb_signing = true;
 553         }
 554
 555         if (signing_state == false) {
 556                 allow_smb_signing = false;
 557                 mandatory_signing = false;
 558         }
 559
 560         if (signing_state == Required) {
 561                 mandatory_signing = true;
 562         }
 563
 564         if (!cli->outbuf || !cli->inbuf)
 565                 goto error;
 566
 567         memset(cli->outbuf, 0, cli->bufsize);
 568         memset(cli->inbuf, 0, cli->bufsize);
 569
 570         /* initialise signing */
 571         cli->signing_state = smb_signing_init(cli,
 572                                               allow_smb_signing,
 573                                               mandatory_signing);
 574         if (!cli->signing_state) {
 575                 goto error;
 576         }
 577
 578         cli->outgoing = tevent_queue_create(cli, "cli_outgoing");
 579         if (cli->outgoing == NULL) {
 580                 goto error;
 581         }
 582         cli->pending = NULL;
 583
 584         cli->initialised = 1;
 585
 586         return cli;
 587
 588         /* Clean up after malloc() error */
 589
 590  error:
 591
 592         SAFE_FREE(cli->inbuf);
 593         SAFE_FREE(cli->outbuf);
 594         TALLOC_FREE(cli);
 595         return NULL;
 596 }
 597
 598 struct cli_state *cli_initialise(void)
 599 {
 600         return cli_initialise_ex(Undefined);
 601 }
 602
 603 /****************************************************************************
 604  Close all pipes open on this session.
 605 ****************************************************************************/
 606
 607 void cli_nt_pipes_close(struct cli_state *cli)
 608 {
 609         while (cli->pipe_list != NULL) {
 610                 /*
 611                  * No TALLOC_FREE here!
 612                  */
 613                 talloc_free(cli->pipe_list);
 614         }
 615 }
 616
 617 /****************************************************************************
 618  Shutdown a client structure.
 619 ****************************************************************************/
 620
 621 static void _cli_shutdown(struct cli_state *cli)
 622 {
 623         cli_nt_pipes_close(cli);
 624
 625         /*
 626          * tell our peer to free his resources.  Wihtout this, when an
 627          * application attempts to do a graceful shutdown and calls
 628          * smbc_free_context() to clean up all connections, some connections
 629          * can remain active on the peer end, until some (long) timeout period
 630          * later.  This tree disconnect forces the peer to clean up, since the
 631          * connection will be going away.
 632          *
 633          * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
 634          * the only user for this so far is smbmount which passes opened connection
 635          * down to kernel's smbfs module.
 636          */
 637         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
 638                 cli_tdis(cli);
 639         }
 640
 641         SAFE_FREE(cli->outbuf);
 642         SAFE_FREE(cli->inbuf);
 643
 644         data_blob_free(&cli->secblob);
 645         data_blob_free(&cli->user_session_key);
 646
 647         if (cli->fd != -1) {
 648                 close(cli->fd);
 649         }
 650         cli->fd = -1;
 651         cli->smb_rw_error = SMB_READ_OK;
 652
 653         /*
 654          * Need to free pending first, they remove themselves
 655          */
 656         while (cli->pending) {
 657                 talloc_free(cli->pending[0]);
 658         }
 659         TALLOC_FREE(cli);
 660 }
 661
 662 void cli_shutdown(struct cli_state *cli)
 663 {
 664         struct cli_state *cli_head;
 665         if (cli == NULL) {
 666                 return;
 667         }
 668         DLIST_HEAD(cli, cli_head);
 669         if (cli_head == cli) {
 670                 /*
 671                  * head of a DFS list, shutdown all subsidiary DFS
 672                  * connections.
 673                  */
 674                 struct cli_state *p, *next;
 675
 676                 for (p = cli_head->next; p; p = next) {
 677                         next = p->next;
 678                         DLIST_REMOVE(cli_head, p);
 679                         _cli_shutdown(p);
 680                 }
 681         } else {
 682                 DLIST_REMOVE(cli_head, cli);
 683         }
 684
 685         _cli_shutdown(cli);
 686 }
 687
 688 /****************************************************************************
 689  Set socket options on a open connection.
 690 ****************************************************************************/
 691
 692 void cli_sockopt(struct cli_state *cli, const char *options)
 693 {
 694         set_socket_options(cli->fd, options);
 695 }
 696
 697 /****************************************************************************
 698  Set the PID to use for smb messages. Return the old pid.
 699 ****************************************************************************/
 700
 701 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 702 {
 703         uint16 ret = cli->pid;
 704         cli->pid = pid;
 705         return ret;
 706 }
 707
 708 /****************************************************************************
 709  Set the case sensitivity flag on the packets. Returns old state.
 710 ****************************************************************************/
 711
 712 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 713 {
 714         bool ret = cli->case_sensitive;
 715         cli->case_sensitive = case_sensitive;
 716         return ret;
 717 }
 718
 719 struct cli_echo_state {
 720         uint16_t vwv[1];
 721         DATA_BLOB data;
 722         int num_echos;
 723 };
 724
 725 static void cli_echo_done(struct tevent_req *subreq);
 726
 727 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 728                                  struct cli_state *cli, uint16_t num_echos,
 729                                  DATA_BLOB data)
 730 {
 731         struct tevent_req *req, *subreq;
 732         struct cli_echo_state *state;
 733
 734         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 735         if (req == NULL) {
 736                 return NULL;
 737         }
 738         SSVAL(state->vwv, 0, num_echos);
 739         state->data = data;
 740         state->num_echos = num_echos;
 741
 742         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 743                               data.length, data.data);
 744         if (subreq == NULL) {
 745                 goto fail;
 746         }
 747         tevent_req_set_callback(subreq, cli_echo_done, req);
 748         return req;
 749  fail:
 750         TALLOC_FREE(req);
 751         return NULL;
 752 }
 753
 754 static void cli_echo_done(struct tevent_req *subreq)
 755 {
 756         struct tevent_req *req = tevent_req_callback_data(
 757                 subreq, struct tevent_req);
 758         struct cli_echo_state *state = tevent_req_data(
 759                 req, struct cli_echo_state);
 760         NTSTATUS status;
 761         uint32_t num_bytes;
 762         uint8_t *bytes;
 763         uint8_t *inbuf;
 764
 765         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 766                               &num_bytes, &bytes);
 767         if (!NT_STATUS_IS_OK(status)) {
 768                 tevent_req_nterror(req, status);
 769                 return;
 770         }
 771         if ((num_bytes != state->data.length)
 772             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 773                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 774                 return;
 775         }
 776
 777         state->num_echos -=1;
 778         if (state->num_echos == 0) {
 779                 tevent_req_done(req);
 780                 return;
 781         }
 782
 783         if (!cli_smb_req_set_pending(subreq)) {
 784                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 785                 return;
 786         }
 787 }
 788
 789 /**
 790  * Get the result out from an echo request
 791  * @param[in] req       The async_req from cli_echo_send
 792  * @retval Did the server reply correctly?
 793  */
 794
 795 NTSTATUS cli_echo_recv(struct tevent_req *req)
 796 {
 797         return tevent_req_simple_recv_ntstatus(req);
 798 }
 799
 800 /**
 801  * @brief Send/Receive SMBEcho requests
 802  * @param[in] mem_ctx   The memory context to put the async_req on
 803  * @param[in] ev        The event context that will call us back
 804  * @param[in] cli       The connection to send the echo to
 805  * @param[in] num_echos How many times do we want to get the reply?
 806  * @param[in] data      The data we want to get back
 807  * @retval Did the server reply correctly?
 808  */
 809
 810 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 811 {
 812         TALLOC_CTX *frame = talloc_stackframe();
 813         struct event_context *ev;
 814         struct tevent_req *req;
 815         NTSTATUS status = NT_STATUS_OK;
 816
 817         if (cli_has_async_calls(cli)) {
 818                 /*
 819                  * Can't use sync call while an async call is in flight
 820                  */
 821                 status = NT_STATUS_INVALID_PARAMETER;
 822                 goto fail;
 823         }
 824
 825         ev = event_context_init(frame);
 826         if (ev == NULL) {
 827                 status = NT_STATUS_NO_MEMORY;
 828                 goto fail;
 829         }
 830
 831         req = cli_echo_send(frame, ev, cli, num_echos, data);
 832         if (req == NULL) {
 833                 status = NT_STATUS_NO_MEMORY;
 834                 goto fail;
 835         }
 836
 837         if (!tevent_req_poll(req, ev)) {
 838                 status = map_nt_error_from_unix(errno);
 839                 goto fail;
 840         }
 841
 842         status = cli_echo_recv(req);
 843  fail:
 844         TALLOC_FREE(frame);
 845         if (!NT_STATUS_IS_OK(status)) {
 846                 cli_set_error(cli, status);
 847         }
 848         return status;
 849 }
 850
 851 /**
 852  * Is the SMB command able to hold an AND_X successor
 853  * @param[in] cmd       The SMB command in question
 854  * @retval Can we add a chained request after "cmd"?
 855  */
 856 bool is_andx_req(uint8_t cmd)
 857 {
 858         switch (cmd) {
 859         case SMBtconX:
 860         case SMBlockingX:
 861         case SMBopenX:
 862         case SMBreadX:
 863         case SMBwriteX:
 864         case SMBsesssetupX:
 865         case SMBulogoffX:
 866         case SMBntcreateX:
 867                 return true;
 868                 break;
 869         default:
 870                 break;
 871         }
 872
 873         return false;
 874 }
 875
 876 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 877                  uint8_t smb_command, uint8_t additional_flags,
 878                  uint8_t wct, uint16_t *vwv,
 879                  uint32_t num_bytes, const uint8_t *bytes,
 880                  struct tevent_req **result_parent,
 881                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 882                  uint32_t *pnum_bytes, uint8_t **pbytes)
 883 {
 884         struct tevent_context *ev;
 885         struct tevent_req *req = NULL;
 886         NTSTATUS status = NT_STATUS_NO_MEMORY;
 887
 888         if (cli_has_async_calls(cli)) {
 889                 return NT_STATUS_INVALID_PARAMETER;
 890         }
 891         ev = tevent_context_init(mem_ctx);
 892         if (ev == NULL) {
 893                 goto fail;
 894         }
 895         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 896                            wct, vwv, num_bytes, bytes);
 897         if (req == NULL) {
 898                 goto fail;
 899         }
 900         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 901                 goto fail;
 902         }
 903         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 904                               pnum_bytes, pbytes);
 905 fail:
 906         TALLOC_FREE(ev);
 907         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 908                 *result_parent = req;
 909         }
 910         return status;
 911 }