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
  23 /*******************************************************************
  24  Setup the word count and byte count for a client smb message.
  25 ********************************************************************/
  26
  27 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
  28 {
  29         if (zero && (num_words || num_bytes)) {
  30                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
  31         }
  32         SCVAL(buf,smb_wct,num_words);
  33         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
  34         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
  35         return (smb_size + num_words*2 + num_bytes);
  36 }
  37
  38 /****************************************************************************
  39  Change the timeout (in milliseconds).
  40 ****************************************************************************/
  41
  42 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
  43 {
  44         unsigned int old_timeout = cli->timeout;
  45         cli->timeout = timeout;
  46         return old_timeout;
  47 }
  48
  49 /****************************************************************************
  50  Change the port number used to call on.
  51 ****************************************************************************/
  52
  53 int cli_set_port(struct cli_state *cli, int port)
  54 {
  55         cli->port = port;
  56         return port;
  57 }
  58
  59 /****************************************************************************
  60  Read an smb from a fd ignoring all keepalive packets. Note that the buffer
  61  *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
  62  The timeout is in milliseconds
  63
  64  This is exactly the same as receive_smb except that it never returns
  65  a session keepalive packet (just as receive_smb used to do).
  66  receive_smb was changed to return keepalives as the oplock processing means this call
  67  should never go into a blocking read.
  68 ****************************************************************************/
  69
  70 static ssize_t client_receive_smb(struct cli_state *cli, size_t maxlen)
  71 {
  72         size_t len;
  73
  74         for(;;) {
  75                 NTSTATUS status;
  76
  77                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
  78
  79                 status = receive_smb_raw(cli->fd, cli->inbuf, cli->timeout,
  80                                          maxlen, &len);
  81                 if (!NT_STATUS_IS_OK(status)) {
  82                         DEBUG(10,("client_receive_smb failed\n"));
  83                         show_msg(cli->inbuf);
  84
  85                         if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
  86                                 set_smb_read_error(&cli->smb_rw_error,
  87                                                    SMB_READ_EOF);
  88                                 return -1;
  89                         }
  90
  91                         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
  92                                 set_smb_read_error(&cli->smb_rw_error,
  93                                                    SMB_READ_TIMEOUT);
  94                                 return -1;
  95                         }
  96
  97                         set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
  98                         return -1;
  99                 }
 100
 101                 if (len < 0) {
 102                         return len;
 103                 }
 104
 105                 /* Ignore session keepalive packets. */
 106                 if(CVAL(cli->inbuf,0) != SMBkeepalive) {
 107                         break;
 108                 }
 109         }
 110
 111         if (cli_encryption_on(cli)) {
 112                 NTSTATUS status = cli_decrypt_message(cli);
 113                 if (!NT_STATUS_IS_OK(status)) {
 114                         DEBUG(0, ("SMB decryption failed on incoming packet! Error %s\n",
 115                                 nt_errstr(status)));
 116                         cli->smb_rw_error = SMB_READ_BAD_DECRYPT;
 117                         return -1;
 118                 }
 119         }
 120
 121         show_msg(cli->inbuf);
 122         return len;
 123 }
 124
 125 /****************************************************************************
 126  Recv an smb.
 127 ****************************************************************************/
 128
 129 bool cli_receive_smb(struct cli_state *cli)
 130 {
 131         ssize_t len;
 132
 133         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
 134         if (cli->fd == -1)
 135                 return false;
 136
 137  again:
 138         len = client_receive_smb(cli, 0);
 139
 140         if (len > 0) {
 141                 /* it might be an oplock break request */
 142                 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
 143                     CVAL(cli->inbuf,smb_com) == SMBlockingX &&
 144                     SVAL(cli->inbuf,smb_vwv6) == 0 &&
 145                     SVAL(cli->inbuf,smb_vwv7) == 0) {
 146                         if (cli->oplock_handler) {
 147                                 int fnum = SVAL(cli->inbuf,smb_vwv2);
 148                                 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
 149                                 if (!cli->oplock_handler(cli, fnum, level)) {
 150                                         return false;
 151                                 }
 152                         }
 153                         /* try to prevent loops */
 154                         SCVAL(cli->inbuf,smb_com,0xFF);
 155                         goto again;
 156                 }
 157         }
 158
 159         /* If the server is not responding, note that now */
 160         if (len < 0) {
 161                 DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
 162                 close(cli->fd);
 163                 cli->fd = -1;
 164                 return false;
 165         }
 166
 167         if (!cli_check_sign_mac(cli, cli->inbuf)) {
 168                 /*
 169                  * If we get a signature failure in sessionsetup, then
 170                  * the server sometimes just reflects the sent signature
 171                  * back to us. Detect this and allow the upper layer to
 172                  * retrieve the correct Windows error message.
 173                  */
 174                 if (CVAL(cli->outbuf,smb_com) == SMBsesssetupX &&
 175                         (smb_len(cli->inbuf) > (smb_ss_field + 8 - 4)) &&
 176                         (SVAL(cli->inbuf,smb_flg2) & FLAGS2_SMB_SECURITY_SIGNATURES) &&
 177                         memcmp(&cli->outbuf[smb_ss_field],&cli->inbuf[smb_ss_field],8) == 0 &&
 178                         cli_is_error(cli)) {
 179
 180                         /*
 181                          * Reflected signature on login error.
 182                          * Set bad sig but don't close fd.
 183                          */
 184                         cli->smb_rw_error = SMB_READ_BAD_SIG;
 185                         return true;
 186                 }
 187
 188                 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
 189                 cli->smb_rw_error = SMB_READ_BAD_SIG;
 190                 close(cli->fd);
 191                 cli->fd = -1;
 192                 return false;
 193         };
 194         return true;
 195 }
 196
 197 /****************************************************************************
 198  Read the data portion of a readX smb.
 199  The timeout is in milliseconds
 200 ****************************************************************************/
 201
 202 ssize_t cli_receive_smb_data(struct cli_state *cli, char *buffer, size_t len)
 203 {
 204         NTSTATUS status;
 205
 206         set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
 207
 208         status = read_socket_with_timeout(
 209                 cli->fd, buffer, len, len, cli->timeout, NULL);
 210         if (NT_STATUS_IS_OK(status)) {
 211                 return len;
 212         }
 213
 214         if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
 215                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_EOF);
 216                 return -1;
 217         }
 218
 219         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
 220                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_TIMEOUT);
 221                 return -1;
 222         }
 223
 224         set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
 225         return -1;
 226 }
 227
 228 /****************************************************************************
 229  Read a smb readX header.
 230  We can only use this if encryption and signing are off.
 231 ****************************************************************************/
 232
 233 bool cli_receive_smb_readX_header(struct cli_state *cli)
 234 {
 235         ssize_t len, offset;
 236
 237         if (cli->fd == -1)
 238                 return false;
 239
 240  again:
 241
 242         /* Read up to the size of a readX header reply. */
 243         len = client_receive_smb(cli, (smb_size - 4) + 24);
 244
 245         if (len > 0) {
 246                 /* it might be an oplock break request */
 247                 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
 248                     CVAL(cli->inbuf,smb_com) == SMBlockingX &&
 249                     SVAL(cli->inbuf,smb_vwv6) == 0 &&
 250                     SVAL(cli->inbuf,smb_vwv7) == 0) {
 251                         ssize_t total_len = smb_len(cli->inbuf);
 252
 253                         if (total_len > CLI_SAMBA_MAX_LARGE_READX_SIZE+SAFETY_MARGIN) {
 254                                 goto read_err;
 255                         }
 256
 257                         /* Read the rest of the data. */
 258                         if ((total_len - len > 0) &&
 259                             !cli_receive_smb_data(cli,cli->inbuf+len,total_len - len)) {
 260                                 goto read_err;
 261                         }
 262
 263                         if (cli->oplock_handler) {
 264                                 int fnum = SVAL(cli->inbuf,smb_vwv2);
 265                                 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
 266                                 if (!cli->oplock_handler(cli, fnum, level)) return false;
 267                         }
 268                         /* try to prevent loops */
 269                         SCVAL(cli->inbuf,smb_com,0xFF);
 270                         goto again;
 271                 }
 272         }
 273
 274         /* If it's not the above size it probably was an error packet. */
 275
 276         if ((len == (smb_size - 4) + 24) && !cli_is_error(cli)) {
 277                 /* Check it's a non-chained readX reply. */
 278                 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) ||
 279                         (CVAL(cli->inbuf,smb_vwv0) != 0xFF) ||
 280                         (CVAL(cli->inbuf,smb_com) != SMBreadX)) {
 281                         /*
 282                          * We're not coping here with asnyc replies to
 283                          * other calls. Punt here - we need async client
 284                          * libs for this.
 285                          */
 286                         goto read_err;
 287                 }
 288
 289                 /*
 290                  * We know it's a readX reply - ensure we've read the
 291                  * padding bytes also.
 292                  */
 293
 294                 offset = SVAL(cli->inbuf,smb_vwv6);
 295                 if (offset > len) {
 296                         ssize_t ret;
 297                         size_t padbytes = offset - len;
 298                         ret = cli_receive_smb_data(cli,smb_buf(cli->inbuf),padbytes);
 299                         if (ret != padbytes) {
 300                                 goto read_err;
 301                         }
 302                 }
 303         }
 304
 305         return true;
 306
 307   read_err:
 308
 309         cli->smb_rw_error = SMB_READ_ERROR;
 310         close(cli->fd);
 311         cli->fd = -1;
 312         return false;
 313 }
 314
 315 static ssize_t write_socket(int fd, const char *buf, size_t len)
 316 {
 317         ssize_t ret=0;
 318
 319         DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
 320         ret = write_data(fd,buf,len);
 321
 322         DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
 323         if(ret <= 0)
 324                 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
 325                         (int)len, fd, strerror(errno) ));
 326
 327         return(ret);
 328 }
 329
 330 /****************************************************************************
 331  Send an smb to a fd.
 332 ****************************************************************************/
 333
 334 bool cli_send_smb(struct cli_state *cli)
 335 {
 336         size_t len;
 337         size_t nwritten=0;
 338         ssize_t ret;
 339         char *buf_out = cli->outbuf;
 340         bool enc_on = cli_encryption_on(cli);
 341
 342         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
 343         if (cli->fd == -1)
 344                 return false;
 345
 346         cli_calculate_sign_mac(cli, cli->outbuf);
 347
 348         if (enc_on) {
 349                 NTSTATUS status = cli_encrypt_message(cli, cli->outbuf,
 350                                                       &buf_out);
 351                 if (!NT_STATUS_IS_OK(status)) {
 352                         close(cli->fd);
 353                         cli->fd = -1;
 354                         cli->smb_rw_error = SMB_WRITE_ERROR;
 355                         DEBUG(0,("Error in encrypting client message. Error %s\n",
 356                                 nt_errstr(status) ));
 357                         return false;
 358                 }
 359         }
 360
 361         len = smb_len(buf_out) + 4;
 362
 363         while (nwritten < len) {
 364                 ret = write_socket(cli->fd,buf_out+nwritten,len - nwritten);
 365                 if (ret <= 0) {
 366                         if (enc_on) {
 367                                 cli_free_enc_buffer(cli, buf_out);
 368                         }
 369                         close(cli->fd);
 370                         cli->fd = -1;
 371                         cli->smb_rw_error = SMB_WRITE_ERROR;
 372                         DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
 373                                 (int)len,(int)ret, strerror(errno) ));
 374                         return false;
 375                 }
 376                 nwritten += ret;
 377         }
 378
 379         if (enc_on) {
 380                 cli_free_enc_buffer(cli, buf_out);
 381         }
 382
 383         /* Increment the mid so we can tell between responses. */
 384         cli->mid++;
 385         if (!cli->mid)
 386                 cli->mid++;
 387         return true;
 388 }
 389
 390 /****************************************************************************
 391  Send a "direct" writeX smb to a fd.
 392 ****************************************************************************/
 393
 394 bool cli_send_smb_direct_writeX(struct cli_state *cli,
 395                                 const char *p,
 396                                 size_t extradata)
 397 {
 398         /* First length to send is the offset to the data. */
 399         size_t len = SVAL(cli->outbuf,smb_vwv11) + 4;
 400         size_t nwritten=0;
 401         ssize_t ret;
 402
 403         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
 404         if (cli->fd == -1) {
 405                 return false;
 406         }
 407
 408         if (client_is_signing_on(cli)) {
 409                 DEBUG(0,("cli_send_smb_large: cannot send signed packet.\n"));
 410                 return false;
 411         }
 412
 413         while (nwritten < len) {
 414                 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
 415                 if (ret <= 0) {
 416                         close(cli->fd);
 417                         cli->fd = -1;
 418                         cli->smb_rw_error = SMB_WRITE_ERROR;
 419                         DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
 420                                 (int)len,(int)ret, strerror(errno) ));
 421                         return false;
 422                 }
 423                 nwritten += ret;
 424         }
 425
 426         /* Now write the extra data. */
 427         nwritten=0;
 428         while (nwritten < extradata) {
 429                 ret = write_socket(cli->fd,p+nwritten,extradata - nwritten);
 430                 if (ret <= 0) {
 431                         close(cli->fd);
 432                         cli->fd = -1;
 433                         cli->smb_rw_error = SMB_WRITE_ERROR;
 434                         DEBUG(0,("Error writing %d extradata "
 435                                 "bytes to client. %d (%s)\n",
 436                                 (int)extradata,(int)ret, strerror(errno) ));
 437                         return false;
 438                 }
 439                 nwritten += ret;
 440         }
 441
 442         /* Increment the mid so we can tell between responses. */
 443         cli->mid++;
 444         if (!cli->mid)
 445                 cli->mid++;
 446         return true;
 447 }
 448
 449 /****************************************************************************
 450  Setup basics in a outgoing packet.
 451 ****************************************************************************/
 452
 453 void cli_setup_packet(struct cli_state *cli)
 454 {
 455         cli->rap_error = 0;
 456         SSVAL(cli->outbuf,smb_pid,cli->pid);
 457         SSVAL(cli->outbuf,smb_uid,cli->vuid);
 458         SSVAL(cli->outbuf,smb_mid,cli->mid);
 459         if (cli->protocol > PROTOCOL_CORE) {
 460                 uint16 flags2;
 461                 if (cli->case_sensitive) {
 462                         SCVAL(cli->outbuf,smb_flg,0x0);
 463                 } else {
 464                         /* Default setting, case insensitive. */
 465                         SCVAL(cli->outbuf,smb_flg,0x8);
 466                 }
 467                 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
 468                 if (cli->capabilities & CAP_UNICODE)
 469                         flags2 |= FLAGS2_UNICODE_STRINGS;
 470                 if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
 471                         flags2 |= FLAGS2_DFS_PATHNAMES;
 472                 if (cli->capabilities & CAP_STATUS32)
 473                         flags2 |= FLAGS2_32_BIT_ERROR_CODES;
 474                 if (cli->use_spnego)
 475                         flags2 |= FLAGS2_EXTENDED_SECURITY;
 476                 SSVAL(cli->outbuf,smb_flg2, flags2);
 477         }
 478 }
 479
 480 /****************************************************************************
 481  Setup the bcc length of the packet from a pointer to the end of the data.
 482 ****************************************************************************/
 483
 484 void cli_setup_bcc(struct cli_state *cli, void *p)
 485 {
 486         set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
 487 }
 488
 489 /****************************************************************************
 490  Initialise credentials of a client structure.
 491 ****************************************************************************/
 492
 493 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
 494 {
 495         fstrcpy(cli->domain, domain);
 496         fstrcpy(cli->user_name, username);
 497         pwd_set_cleartext(&cli->pwd, password);
 498         if (!*username) {
 499                 cli->pwd.null_pwd = true;
 500         }
 501
 502         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
 503 }
 504
 505 /****************************************************************************
 506  Set the signing state (used from the command line).
 507 ****************************************************************************/
 508
 509 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
 510 {
 511         if (signing_state == Undefined)
 512                 return;
 513
 514         if (signing_state == false) {
 515                 cli->sign_info.allow_smb_signing = false;
 516                 cli->sign_info.mandatory_signing = false;
 517                 return;
 518         }
 519
 520         cli->sign_info.allow_smb_signing = true;
 521
 522         if (signing_state == Required)
 523                 cli->sign_info.mandatory_signing = true;
 524 }
 525
 526 /****************************************************************************
 527  Initialise a client structure. Always returns a malloc'ed struct.
 528 ****************************************************************************/
 529
 530 struct cli_state *cli_initialise(void)
 531 {
 532         struct cli_state *cli = NULL;
 533
 534         /* Check the effective uid - make sure we are not setuid */
 535         if (is_setuid_root()) {
 536                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 537                 return NULL;
 538         }
 539
 540         cli = SMB_MALLOC_P(struct cli_state);
 541         if (!cli) {
 542                 return NULL;
 543         }
 544
 545         ZERO_STRUCTP(cli);
 546
 547         cli->port = 0;
 548         cli->fd = -1;
 549         cli->cnum = -1;
 550         cli->pid = (uint16)sys_getpid();
 551         cli->mid = 1;
 552         cli->vuid = UID_FIELD_INVALID;
 553         cli->protocol = PROTOCOL_NT1;
 554         cli->timeout = 20000; /* Timeout is in milliseconds. */
 555         cli->bufsize = CLI_BUFFER_SIZE+4;
 556         cli->max_xmit = cli->bufsize;
 557         cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 558         cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 559         cli->oplock_handler = cli_oplock_ack;
 560         cli->case_sensitive = false;
 561         cli->smb_rw_error = SMB_READ_OK;
 562
 563         cli->use_spnego = lp_client_use_spnego();
 564
 565         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 566
 567         /* Set the CLI_FORCE_DOSERR environment variable to test
 568            client routines using DOS errors instead of STATUS32
 569            ones.  This intended only as a temporary hack. */
 570         if (getenv("CLI_FORCE_DOSERR"))
 571                 cli->force_dos_errors = true;
 572
 573         if (lp_client_signing())
 574                 cli->sign_info.allow_smb_signing = true;
 575
 576         if (lp_client_signing() == Required)
 577                 cli->sign_info.mandatory_signing = true;
 578
 579         if (!cli->outbuf || !cli->inbuf)
 580                 goto error;
 581
 582         memset(cli->outbuf, 0, cli->bufsize);
 583         memset(cli->inbuf, 0, cli->bufsize);
 584
 585
 586 #if defined(DEVELOPER)
 587         /* just because we over-allocate, doesn't mean it's right to use it */
 588         clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
 589         clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
 590 #endif
 591
 592         /* initialise signing */
 593         cli_null_set_signing(cli);
 594
 595         cli->initialised = 1;
 596
 597         return cli;
 598
 599         /* Clean up after malloc() error */
 600
 601  error:
 602
 603         SAFE_FREE(cli->inbuf);
 604         SAFE_FREE(cli->outbuf);
 605         SAFE_FREE(cli);
 606         return NULL;
 607 }
 608
 609 /****************************************************************************
 610  External interface.
 611  Close an open named pipe over SMB. Free any authentication data.
 612  Returns false if the cli_close call failed.
 613  ****************************************************************************/
 614
 615 bool cli_rpc_pipe_close(struct rpc_pipe_client *cli)
 616 {
 617         bool ret;
 618
 619         if (!cli) {
 620                 return false;
 621         }
 622
 623         ret = cli_close(cli->cli, cli->fnum);
 624
 625         if (!ret) {
 626                 DEBUG(1,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
 627                          "fnum 0x%x "
 628                          "to machine %s.  Error was %s\n",
 629                          cli->pipe_name,
 630                          (int) cli->fnum,
 631                          cli->cli->desthost,
 632                          cli_errstr(cli->cli)));
 633         }
 634
 635         if (cli->auth.cli_auth_data_free_func) {
 636                 (*cli->auth.cli_auth_data_free_func)(&cli->auth);
 637         }
 638
 639         DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
 640                 cli->pipe_name, cli->cli->desthost ));
 641
 642         DLIST_REMOVE(cli->cli->pipe_list, cli);
 643         talloc_destroy(cli->mem_ctx);
 644         return ret;
 645 }
 646
 647 /****************************************************************************
 648  Close all pipes open on this session.
 649 ****************************************************************************/
 650
 651 void cli_nt_pipes_close(struct cli_state *cli)
 652 {
 653         struct rpc_pipe_client *cp, *next;
 654
 655         for (cp = cli->pipe_list; cp; cp = next) {
 656                 next = cp->next;
 657                 cli_rpc_pipe_close(cp);
 658         }
 659 }
 660
 661 /****************************************************************************
 662  Shutdown a client structure.
 663 ****************************************************************************/
 664
 665 void cli_shutdown(struct cli_state *cli)
 666 {
 667         cli_nt_pipes_close(cli);
 668
 669         /*
 670          * tell our peer to free his resources.  Wihtout this, when an
 671          * application attempts to do a graceful shutdown and calls
 672          * smbc_free_context() to clean up all connections, some connections
 673          * can remain active on the peer end, until some (long) timeout period
 674          * later.  This tree disconnect forces the peer to clean up, since the
 675          * connection will be going away.
 676          *
 677          * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
 678          * the only user for this so far is smbmount which passes opened connection
 679          * down to kernel's smbfs module.
 680          */
 681         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
 682                 cli_tdis(cli);
 683         }
 684
 685         SAFE_FREE(cli->outbuf);
 686         SAFE_FREE(cli->inbuf);
 687
 688         cli_free_signing_context(cli);
 689         data_blob_free(&cli->secblob);
 690         data_blob_free(&cli->user_session_key);
 691
 692         if (cli->fd != -1) {
 693                 close(cli->fd);
 694         }
 695         cli->fd = -1;
 696         cli->smb_rw_error = SMB_READ_OK;
 697
 698         SAFE_FREE(cli);
 699 }
 700
 701 /****************************************************************************
 702  Set socket options on a open connection.
 703 ****************************************************************************/
 704
 705 void cli_sockopt(struct cli_state *cli, const char *options)
 706 {
 707         set_socket_options(cli->fd, options);
 708 }
 709
 710 /****************************************************************************
 711  Set the PID to use for smb messages. Return the old pid.
 712 ****************************************************************************/
 713
 714 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 715 {
 716         uint16 ret = cli->pid;
 717         cli->pid = pid;
 718         return ret;
 719 }
 720
 721 /****************************************************************************
 722  Set the case sensitivity flag on the packets. Returns old state.
 723 ****************************************************************************/
 724
 725 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 726 {
 727         bool ret = cli->case_sensitive;
 728         cli->case_sensitive = case_sensitive;
 729         return ret;
 730 }
 731
 732 /****************************************************************************
 733 Send a keepalive packet to the server
 734 ****************************************************************************/
 735
 736 bool cli_send_keepalive(struct cli_state *cli)
 737 {
 738         if (cli->fd == -1) {
 739                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
 740                 return false;
 741         }
 742         if (!send_keepalive(cli->fd)) {
 743                 close(cli->fd);
 744                 cli->fd = -1;
 745                 DEBUG(0,("Error sending keepalive packet to client.\n"));
 746                 return false;
 747         }
 748         return true;
 749 }
 750
 751 /****************************************************************************
 752  Send/receive a SMBecho command: ping the server
 753 ****************************************************************************/
 754
 755 bool cli_echo(struct cli_state *cli, uint16 num_echos,
 756               unsigned char *data, size_t length)
 757 {
 758         char *p;
 759         int i;
 760
 761         SMB_ASSERT(length < 1024);
 762
 763         memset(cli->outbuf,'\0',smb_size);
 764         cli_set_message(cli->outbuf,1,length,true);
 765         SCVAL(cli->outbuf,smb_com,SMBecho);
 766         SSVAL(cli->outbuf,smb_tid,65535);
 767         SSVAL(cli->outbuf,smb_vwv0,num_echos);
 768         cli_setup_packet(cli);
 769         p = smb_buf(cli->outbuf);
 770         memcpy(p, data, length);
 771         p += length;
 772
 773         cli_setup_bcc(cli, p);
 774
 775         cli_send_smb(cli);
 776
 777         for (i=0; i<num_echos; i++) {
 778                 if (!cli_receive_smb(cli)) {
 779                         return false;
 780                 }
 781
 782                 if (cli_is_error(cli)) {
 783                         return false;
 784                 }
 785         }
 786
 787         return true;
 788 }