source3/libsmb/clientgen.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB client generic functions
   4    Copyright (C) Andrew Tridgell 1994-1998
   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 2 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, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #include "includes.h"
  22
  23 /****************************************************************************
  24  Change the timeout (in milliseconds).
  25 ****************************************************************************/
  26
  27 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
  28 {
  29         unsigned int old_timeout = cli->timeout;
  30         cli->timeout = timeout;
  31         return old_timeout;
  32 }
  33
  34 /****************************************************************************
  35  Change the port number used to call on.
  36 ****************************************************************************/
  37
  38 int cli_set_port(struct cli_state *cli, int port)
  39 {
  40         cli->port = port;
  41         return port;
  42 }
  43
  44 /****************************************************************************
  45  Read an smb from a fd ignoring all keepalive packets. Note that the buffer
  46  *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
  47  The timeout is in milliseconds
  48
  49  This is exactly the same as receive_smb except that it never returns
  50  a session keepalive packet (just as receive_smb used to do).
  51  receive_smb was changed to return keepalives as the oplock processing means this call
  52  should never go into a blocking read.
  53 ****************************************************************************/
  54
  55 static BOOL client_receive_smb(int fd,char *buffer, unsigned int timeout)
  56 {
  57         BOOL ret;
  58
  59         for(;;) {
  60                 ret = receive_smb_raw(fd, buffer, timeout);
  61
  62                 if (!ret) {
  63                         DEBUG(10,("client_receive_smb failed\n"));
  64                         show_msg(buffer);
  65                         return ret;
  66                 }
  67
  68                 /* Ignore session keepalive packets. */
  69                 if(CVAL(buffer,0) != SMBkeepalive)
  70                         break;
  71         }
  72         show_msg(buffer);
  73         return ret;
  74 }
  75
  76 /****************************************************************************
  77  Recv an smb.
  78 ****************************************************************************/
  79
  80 BOOL cli_receive_smb(struct cli_state *cli)
  81 {
  82         extern int smb_read_error;
  83         BOOL ret;
  84
  85         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
  86         if (cli->fd == -1)
  87                 return False;
  88
  89  again:
  90         ret = client_receive_smb(cli->fd,cli->inbuf,cli->timeout);
  91
  92         if (ret) {
  93                 /* it might be an oplock break request */
  94                 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
  95                     CVAL(cli->inbuf,smb_com) == SMBlockingX &&
  96                     SVAL(cli->inbuf,smb_vwv6) == 0 &&
  97                     SVAL(cli->inbuf,smb_vwv7) == 0) {
  98                         if (cli->oplock_handler) {
  99                                 int fnum = SVAL(cli->inbuf,smb_vwv2);
 100                                 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
 101                                 if (!cli->oplock_handler(cli, fnum, level)) return False;
 102                         }
 103                         /* try to prevent loops */
 104                         SCVAL(cli->inbuf,smb_com,0xFF);
 105                         goto again;
 106                 }
 107         }
 108
 109         /* If the server is not responding, note that now */
 110
 111         if (!ret) {
 112                 cli->smb_rw_error = smb_read_error;
 113                 close(cli->fd);
 114                 cli->fd = -1;
 115                 return ret;
 116         }
 117
 118         if (!cli_check_sign_mac(cli)) {
 119                 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
 120                 cli->smb_rw_error = READ_BAD_SIG;
 121                 close(cli->fd);
 122                 cli->fd = -1;
 123                 return False;
 124         };
 125         return True;
 126 }
 127
 128 static ssize_t write_socket(int fd, const char *buf, size_t len)
 129 {
 130         ssize_t ret=0;
 131
 132         DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
 133         ret = write_data(fd,buf,len);
 134
 135         DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
 136         if(ret <= 0)
 137                 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
 138                         (int)len, fd, strerror(errno) ));
 139
 140         return(ret);
 141 }
 142
 143 /****************************************************************************
 144  Send an smb to a fd.
 145 ****************************************************************************/
 146
 147 BOOL cli_send_smb(struct cli_state *cli)
 148 {
 149         size_t len;
 150         size_t nwritten=0;
 151         ssize_t ret;
 152
 153         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
 154         if (cli->fd == -1)
 155                 return False;
 156
 157         cli_calculate_sign_mac(cli);
 158
 159         len = smb_len(cli->outbuf) + 4;
 160
 161         while (nwritten < len) {
 162                 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
 163                 if (ret <= 0) {
 164                         close(cli->fd);
 165                         cli->fd = -1;
 166                         cli->smb_rw_error = WRITE_ERROR;
 167                         DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
 168                                 (int)len,(int)ret, strerror(errno) ));
 169                         return False;
 170                 }
 171                 nwritten += ret;
 172         }
 173         /* Increment the mid so we can tell between responses. */
 174         cli->mid++;
 175         if (!cli->mid)
 176                 cli->mid++;
 177         return True;
 178 }
 179
 180 /****************************************************************************
 181  Setup basics in a outgoing packet.
 182 ****************************************************************************/
 183
 184 void cli_setup_packet(struct cli_state *cli)
 185 {
 186         cli->rap_error = 0;
 187         SSVAL(cli->outbuf,smb_pid,cli->pid);
 188         SSVAL(cli->outbuf,smb_uid,cli->vuid);
 189         SSVAL(cli->outbuf,smb_mid,cli->mid);
 190         if (cli->protocol > PROTOCOL_CORE) {
 191                 uint16 flags2;
 192                 if (cli->case_sensitive) {
 193                         SCVAL(cli->outbuf,smb_flg,0x0);
 194                 } else {
 195                         /* Default setting, case insensitive. */
 196                         SCVAL(cli->outbuf,smb_flg,0x8);
 197                 }
 198                 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
 199                 if (cli->capabilities & CAP_UNICODE)
 200                         flags2 |= FLAGS2_UNICODE_STRINGS;
 201                 if (cli->capabilities & CAP_DFS)
 202                         flags2 |= FLAGS2_DFS_PATHNAMES;
 203                 if (cli->capabilities & CAP_STATUS32)
 204                         flags2 |= FLAGS2_32_BIT_ERROR_CODES;
 205                 if (cli->use_spnego)
 206                         flags2 |= FLAGS2_EXTENDED_SECURITY;
 207                 SSVAL(cli->outbuf,smb_flg2, flags2);
 208         }
 209 }
 210
 211 /****************************************************************************
 212  Setup the bcc length of the packet from a pointer to the end of the data.
 213 ****************************************************************************/
 214
 215 void cli_setup_bcc(struct cli_state *cli, void *p)
 216 {
 217         set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
 218 }
 219
 220 /****************************************************************************
 221  Initialise credentials of a client structure.
 222 ****************************************************************************/
 223
 224 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
 225 {
 226         fstrcpy(cli->domain, domain);
 227         fstrcpy(cli->user_name, username);
 228         pwd_set_cleartext(&cli->pwd, password);
 229         if (!*username) {
 230                 cli->pwd.null_pwd = True;
 231         }
 232
 233         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
 234 }
 235
 236 /****************************************************************************
 237  Set the signing state (used from the command line).
 238 ****************************************************************************/
 239
 240 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
 241 {
 242         if (signing_state == Undefined)
 243                 return;
 244
 245         if (signing_state == False) {
 246                 cli->sign_info.allow_smb_signing = False;
 247                 cli->sign_info.mandatory_signing = False;
 248                 return;
 249         }
 250
 251         cli->sign_info.allow_smb_signing = True;
 252
 253         if (signing_state == Required)
 254                 cli->sign_info.mandatory_signing = True;
 255 }
 256
 257 /****************************************************************************
 258  Initialise a client structure.
 259 ****************************************************************************/
 260
 261 struct cli_state *cli_initialise(struct cli_state *cli)
 262 {
 263         BOOL alloced_cli = False;
 264
 265         /* Check the effective uid - make sure we are not setuid */
 266         if (is_setuid_root()) {
 267                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 268                 return NULL;
 269         }
 270
 271         if (!cli) {
 272                 cli = SMB_MALLOC_P(struct cli_state);
 273                 if (!cli)
 274                         return NULL;
 275                 ZERO_STRUCTP(cli);
 276                 alloced_cli = True;
 277         }
 278
 279         if (cli->initialised)
 280                 cli_close_connection(cli);
 281
 282         ZERO_STRUCTP(cli);
 283
 284         cli->port = 0;
 285         cli->fd = -1;
 286         cli->cnum = -1;
 287         cli->pid = (uint16)sys_getpid();
 288         cli->mid = 1;
 289         cli->vuid = UID_FIELD_INVALID;
 290         cli->protocol = PROTOCOL_NT1;
 291         cli->timeout = 20000; /* Timeout is in milliseconds. */
 292         cli->bufsize = CLI_BUFFER_SIZE+4;
 293         cli->max_xmit = cli->bufsize;
 294         cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 295         cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 296         cli->oplock_handler = cli_oplock_ack;
 297         cli->case_sensitive = False;
 298         cli->smb_rw_error = 0;
 299
 300         cli->use_spnego = lp_client_use_spnego();
 301
 302         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 303
 304         /* Set the CLI_FORCE_DOSERR environment variable to test
 305            client routines using DOS errors instead of STATUS32
 306            ones.  This intended only as a temporary hack. */
 307         if (getenv("CLI_FORCE_DOSERR"))
 308                 cli->force_dos_errors = True;
 309
 310         if (lp_client_signing())
 311                 cli->sign_info.allow_smb_signing = True;
 312
 313         if (lp_client_signing() == Required)
 314                 cli->sign_info.mandatory_signing = True;
 315
 316         if (!cli->outbuf || !cli->inbuf)
 317                 goto error;
 318
 319         if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
 320                 goto error;
 321
 322         memset(cli->outbuf, 0, cli->bufsize);
 323         memset(cli->inbuf, 0, cli->bufsize);
 324
 325
 326 #if defined(DEVELOPER)
 327         /* just because we over-allocate, doesn't mean it's right to use it */
 328         clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
 329         clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
 330 #endif
 331
 332         /* initialise signing */
 333         cli_null_set_signing(cli);
 334
 335         cli->initialised = 1;
 336         cli->allocated = alloced_cli;
 337
 338         return cli;
 339
 340         /* Clean up after malloc() error */
 341
 342  error:
 343
 344         SAFE_FREE(cli->inbuf);
 345         SAFE_FREE(cli->outbuf);
 346
 347         if (alloced_cli)
 348                 SAFE_FREE(cli);
 349
 350         return NULL;
 351 }
 352
 353 /****************************************************************************
 354  External interface.
 355  Close an open named pipe over SMB. Free any authentication data.
 356  ****************************************************************************/
 357
 358 void cli_rpc_pipe_close(struct rpc_pipe_client *cli)
 359 {
 360         if (!cli_close(cli->cli, cli->fnum)) {
 361                 DEBUG(0,("cli_rpc_pipe_close: cli_close failed on pipe %s "
 362                         "to machine %s.  Error was %s\n",
 363                         cli->pipe_name,
 364                         cli->cli->desthost,
 365                         cli_errstr(cli->cli)));
 366         }
 367
 368         if (cli->auth.cli_auth_data_free_func) {
 369                 (*cli->auth.cli_auth_data_free_func)(&cli->auth);
 370         }
 371
 372         DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
 373                 cli->pipe_name, cli->cli->desthost ));
 374
 375         DLIST_REMOVE(cli->cli->pipe_list, cli);
 376         talloc_destroy(cli->mem_ctx);
 377 }
 378
 379 /****************************************************************************
 380  Close all pipes open on this session.
 381 ****************************************************************************/
 382
 383 void cli_nt_pipes_close(struct cli_state *cli)
 384 {
 385         struct rpc_pipe_client *cp, *next;
 386
 387         for (cp = cli->pipe_list; cp; cp = next) {
 388                 next = cp->next;
 389                 cli_rpc_pipe_close(cp);
 390         }
 391 }
 392
 393 /****************************************************************************
 394  Close a client connection and free the memory without destroying cli itself.
 395 ****************************************************************************/
 396
 397 void cli_close_connection(struct cli_state *cli)
 398 {
 399         cli_nt_pipes_close(cli);
 400
 401         /*
 402          * tell our peer to free his resources.  Wihtout this, when an
 403          * application attempts to do a graceful shutdown and calls
 404          * smbc_free_context() to clean up all connections, some connections
 405          * can remain active on the peer end, until some (long) timeout period
 406          * later.  This tree disconnect forces the peer to clean up, since the
 407          * connection will be going away.
 408          *
 409          * Also, do not do tree disconnect when cli->smb_rw_error is DO_NOT_DO_TDIS
 410          * the only user for this so far is smbmount which passes opened connection
 411          * down to kernel's smbfs module.
 412          */
 413         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != DO_NOT_DO_TDIS ) ) {
 414                 cli_tdis(cli);
 415         }
 416
 417         SAFE_FREE(cli->outbuf);
 418         SAFE_FREE(cli->inbuf);
 419
 420         cli_free_signing_context(cli);
 421         data_blob_free(&cli->secblob);
 422         data_blob_free(&cli->user_session_key);
 423
 424         if (cli->mem_ctx) {
 425                 talloc_destroy(cli->mem_ctx);
 426                 cli->mem_ctx = NULL;
 427         }
 428
 429         if (cli->fd != -1) {
 430                 close(cli->fd);
 431         }
 432         cli->fd = -1;
 433         cli->smb_rw_error = 0;
 434 }
 435
 436 /****************************************************************************
 437  Shutdown a client structure.
 438 ****************************************************************************/
 439
 440 void cli_shutdown(struct cli_state *cli)
 441 {
 442         BOOL allocated = cli->allocated;
 443         cli_close_connection(cli);
 444         ZERO_STRUCTP(cli);
 445         if (allocated) {
 446                 free(cli);
 447         }
 448 }
 449
 450 /****************************************************************************
 451  Set socket options on a open connection.
 452 ****************************************************************************/
 453
 454 void cli_sockopt(struct cli_state *cli, const char *options)
 455 {
 456         set_socket_options(cli->fd, options);
 457 }
 458
 459 /****************************************************************************
 460  Set the PID to use for smb messages. Return the old pid.
 461 ****************************************************************************/
 462
 463 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 464 {
 465         uint16 ret = cli->pid;
 466         cli->pid = pid;
 467         return ret;
 468 }
 469
 470 /****************************************************************************
 471  Set the case sensitivity flag on the packets. Returns old state.
 472 ****************************************************************************/
 473
 474 BOOL cli_set_case_sensitive(struct cli_state *cli, BOOL case_sensitive)
 475 {
 476         BOOL ret = cli->case_sensitive;
 477         cli->case_sensitive = case_sensitive;
 478         return ret;
 479 }
 480
 481 /****************************************************************************
 482 Send a keepalive packet to the server
 483 ****************************************************************************/
 484 BOOL cli_send_keepalive(struct cli_state *cli)
 485 {
 486         if (cli->fd == -1) {
 487                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
 488                 return False;
 489         }
 490         if (!send_keepalive(cli->fd)) {
 491                 close(cli->fd);
 492                 cli->fd = -1;
 493                 DEBUG(0,("Error sending keepalive packet to client.\n"));
 494                 return False;
 495         }
 496         return True;
 497 }