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 #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(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         return True;
 161 }
 162
 163 /****************************************************************************
 164  Setup basics in a outgoing packet.
 165 ****************************************************************************/
 166
 167 void cli_setup_packet(struct cli_state *cli)
 168 {
 169         cli->rap_error = 0;
 170         SSVAL(cli->outbuf,smb_pid,cli->pid);
 171         SSVAL(cli->outbuf,smb_uid,cli->vuid);
 172         SSVAL(cli->outbuf,smb_mid,cli->mid);
 173         if (cli->protocol > PROTOCOL_CORE) {
 174                 uint16 flags2;
 175                 SCVAL(cli->outbuf,smb_flg,0x8);
 176                 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
 177                 if (cli->capabilities & CAP_UNICODE)
 178                         flags2 |= FLAGS2_UNICODE_STRINGS;
 179                 if (cli->capabilities & CAP_STATUS32)
 180                         flags2 |= FLAGS2_32_BIT_ERROR_CODES;
 181                 if (cli->use_spnego)
 182                         flags2 |= FLAGS2_EXTENDED_SECURITY;
 183                 SSVAL(cli->outbuf,smb_flg2, flags2);
 184         }
 185 }
 186
 187 /****************************************************************************
 188  Setup the bcc length of the packet from a pointer to the end of the data.
 189 ****************************************************************************/
 190
 191 void cli_setup_bcc(struct cli_state *cli, void *p)
 192 {
 193         set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
 194 }
 195
 196 /****************************************************************************
 197  Initialise credentials of a client structure.
 198 ****************************************************************************/
 199
 200 void cli_init_creds(struct cli_state *cli, const struct ntuser_creds *usr)
 201 {
 202         /* copy_nt_creds(&cli->usr, usr); */
 203         fstrcpy(cli->domain   , usr->domain);
 204         fstrcpy(cli->user_name, usr->user_name);
 205         memcpy(&cli->pwd, &usr->pwd, sizeof(usr->pwd));
 206
 207         DEBUG(10,("cli_init_creds: user %s domain %s\n",
 208                cli->user_name, cli->domain));
 209 }
 210
 211 /****************************************************************************
 212  Set the signing state (used from the command line).
 213 ****************************************************************************/
 214
 215 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
 216 {
 217         if (signing_state == Undefined)
 218                 return;
 219
 220         if (signing_state == False) {
 221                 cli->sign_info.allow_smb_signing = False;
 222                 cli->sign_info.mandatory_signing = False;
 223                 return;
 224         }
 225
 226         cli->sign_info.allow_smb_signing = True;
 227
 228         if (signing_state == Required)
 229                 cli->sign_info.mandatory_signing = True;
 230 }
 231
 232 /****************************************************************************
 233  Initialise a client structure.
 234 ****************************************************************************/
 235
 236 struct cli_state *cli_initialise(struct cli_state *cli)
 237 {
 238         BOOL alloced_cli = False;
 239
 240         /* Check the effective uid - make sure we are not setuid */
 241         if (is_setuid_root()) {
 242                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 243                 return NULL;
 244         }
 245
 246         if (!cli) {
 247                 cli = (struct cli_state *)malloc(sizeof(*cli));
 248                 if (!cli)
 249                         return NULL;
 250                 ZERO_STRUCTP(cli);
 251                 alloced_cli = True;
 252         }
 253
 254         if (cli->initialised)
 255                 cli_close_connection(cli);
 256
 257         ZERO_STRUCTP(cli);
 258
 259         cli->port = 0;
 260         cli->fd = -1;
 261         cli->cnum = -1;
 262         cli->pid = (uint16)sys_getpid();
 263         cli->mid = 1;
 264         cli->vuid = UID_FIELD_INVALID;
 265         cli->protocol = PROTOCOL_NT1;
 266         cli->timeout = 20000; /* Timeout is in milliseconds. */
 267         cli->bufsize = CLI_BUFFER_SIZE+4;
 268         cli->max_xmit = cli->bufsize;
 269         cli->outbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
 270         cli->inbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
 271         cli->oplock_handler = cli_oplock_ack;
 272
 273         cli->use_spnego = lp_client_use_spnego();
 274
 275         cli->capabilities = CAP_UNICODE | CAP_STATUS32;
 276
 277         /* Set the CLI_FORCE_DOSERR environment variable to test
 278            client routines using DOS errors instead of STATUS32
 279            ones.  This intended only as a temporary hack. */
 280         if (getenv("CLI_FORCE_DOSERR"))
 281                 cli->force_dos_errors = True;
 282
 283         if (lp_client_signing())
 284                 cli->sign_info.allow_smb_signing = True;
 285
 286         if (lp_client_signing() == Required)
 287                 cli->sign_info.mandatory_signing = True;
 288
 289         if (!cli->outbuf || !cli->inbuf)
 290                 goto error;
 291
 292         if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
 293                 goto error;
 294
 295         memset(cli->outbuf, 0, cli->bufsize);
 296         memset(cli->inbuf, 0, cli->bufsize);
 297
 298         /* just because we over-allocate, doesn't mean it's right to use it */
 299         clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
 300         clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
 301
 302         /* initialise signing */
 303         cli_null_set_signing(cli);
 304
 305         cli->nt_pipe_fnum = 0;
 306         cli->saved_netlogon_pipe_fnum = 0;
 307
 308         cli->initialised = 1;
 309         cli->allocated = alloced_cli;
 310
 311         cli->pipe_idx = -1;
 312
 313         return cli;
 314
 315         /* Clean up after malloc() error */
 316
 317  error:
 318
 319         SAFE_FREE(cli->inbuf);
 320         SAFE_FREE(cli->outbuf);
 321
 322         if (alloced_cli)
 323                 SAFE_FREE(cli);
 324
 325         return NULL;
 326 }
 327
 328 /****************************************************************************
 329 close the session
 330 ****************************************************************************/
 331
 332 void cli_nt_session_close(struct cli_state *cli)
 333 {
 334         if (cli->ntlmssp_pipe_state) {
 335                 ntlmssp_client_end(&cli->ntlmssp_pipe_state);
 336         }
 337
 338         cli_close(cli, cli->nt_pipe_fnum);
 339         cli->nt_pipe_fnum = 0;
 340         cli->pipe_idx = -1;
 341 }
 342
 343 /****************************************************************************
 344 close the NETLOGON session holding the session key for NETSEC
 345 ****************************************************************************/
 346
 347 void cli_nt_netlogon_netsec_session_close(struct cli_state *cli)
 348 {
 349         if (cli->saved_netlogon_pipe_fnum != 0) {
 350                 cli_close(cli, cli->saved_netlogon_pipe_fnum);
 351                 cli->saved_netlogon_pipe_fnum = 0;
 352         }
 353 }
 354
 355 /****************************************************************************
 356  Close a client connection and free the memory without destroying cli itself.
 357 ****************************************************************************/
 358
 359 void cli_close_connection(struct cli_state *cli)
 360 {
 361         cli_nt_session_close(cli);
 362         cli_nt_netlogon_netsec_session_close(cli);
 363
 364         SAFE_FREE(cli->outbuf);
 365         SAFE_FREE(cli->inbuf);
 366
 367         cli_free_signing_context(cli);
 368         data_blob_free(&cli->secblob);
 369
 370         if (cli->ntlmssp_pipe_state)
 371                 ntlmssp_client_end(&cli->ntlmssp_pipe_state);
 372
 373         if (cli->mem_ctx) {
 374                 talloc_destroy(cli->mem_ctx);
 375                 cli->mem_ctx = NULL;
 376         }
 377
 378         if (cli->fd != -1)
 379                 close(cli->fd);
 380         cli->fd = -1;
 381         cli->smb_rw_error = 0;
 382
 383 }
 384
 385 /****************************************************************************
 386  Shutdown a client structure.
 387 ****************************************************************************/
 388
 389 void cli_shutdown(struct cli_state *cli)
 390 {
 391         BOOL allocated = cli->allocated;
 392         cli_close_connection(cli);
 393         ZERO_STRUCTP(cli);
 394         if (allocated)
 395                 free(cli);
 396 }
 397
 398 /****************************************************************************
 399  Set socket options on a open connection.
 400 ****************************************************************************/
 401
 402 void cli_sockopt(struct cli_state *cli, const char *options)
 403 {
 404         set_socket_options(cli->fd, options);
 405 }
 406
 407 /****************************************************************************
 408  Set the PID to use for smb messages. Return the old pid.
 409 ****************************************************************************/
 410
 411 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 412 {
 413         uint16 ret = cli->pid;
 414         cli->pid = pid;
 415         return ret;
 416 }
 417
 418 /****************************************************************************
 419 Send a keepalive packet to the server
 420 ****************************************************************************/
 421 BOOL cli_send_keepalive(struct cli_state *cli)
 422 {
 423         if (cli->fd == -1) {
 424                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
 425                 return False;
 426         }
 427         if (!send_keepalive(cli->fd)) {
 428                 close(cli->fd);
 429                 cli->fd = -1;
 430                 DEBUG(0,("Error sending keepalive packet to client.\n"));
 431                 return False;
 432         }
 433         return True;
 434 }