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