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_caclulate_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  Initialise a client structure.
 213 ****************************************************************************/
 214
 215 struct cli_state *cli_initialise(struct cli_state *cli)
 216 {
 217         BOOL alloced_cli = False;
 218
 219         /* Check the effective uid - make sure we are not setuid */
 220         if (is_setuid_root()) {
 221                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 222                 return NULL;
 223         }
 224
 225         if (!cli) {
 226                 cli = (struct cli_state *)malloc(sizeof(*cli));
 227                 if (!cli)
 228                         return NULL;
 229                 ZERO_STRUCTP(cli);
 230                 alloced_cli = True;
 231         }
 232
 233         if (cli->initialised)
 234                 cli_close_connection(cli);
 235
 236         ZERO_STRUCTP(cli);
 237
 238         cli->port = 0;
 239         cli->fd = -1;
 240         cli->cnum = -1;
 241         cli->pid = (uint16)sys_getpid();
 242         cli->mid = 1;
 243         cli->vuid = UID_FIELD_INVALID;
 244         cli->protocol = PROTOCOL_NT1;
 245         cli->timeout = 20000; /* Timeout is in milliseconds. */
 246         cli->bufsize = CLI_BUFFER_SIZE+4;
 247         cli->max_xmit = cli->bufsize;
 248         cli->outbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
 249         cli->inbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
 250         cli->oplock_handler = cli_oplock_ack;
 251
 252         cli->use_spnego = lp_client_use_spnego();
 253
 254         cli->capabilities = CAP_UNICODE | CAP_STATUS32;
 255
 256         /* Set the CLI_FORCE_DOSERR environment variable to test
 257            client routines using DOS errors instead of STATUS32
 258            ones.  This intended only as a temporary hack. */
 259         if (getenv("CLI_FORCE_DOSERR"))
 260                 cli->force_dos_errors = True;
 261
 262         if (lp_client_signing())
 263                 cli->sign_info.allow_smb_signing = True;
 264
 265         if (lp_client_signing() == Required)
 266                 cli->sign_info.mandatory_signing = True;
 267
 268         if (!cli->outbuf || !cli->inbuf)
 269                 goto error;
 270
 271         if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
 272                 goto error;
 273
 274         memset(cli->outbuf, 0, cli->bufsize);
 275         memset(cli->inbuf, 0, cli->bufsize);
 276
 277         /* just because we over-allocate, doesn't mean it's right to use it */
 278         clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
 279         clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
 280
 281         /* initialise signing */
 282         cli_null_set_signing(cli);
 283
 284         cli->nt_pipe_fnum = 0;
 285         cli->saved_netlogon_pipe_fnum = 0;
 286
 287         cli->initialised = 1;
 288         cli->allocated = alloced_cli;
 289
 290         cli->pipe_idx = -1;
 291
 292         return cli;
 293
 294         /* Clean up after malloc() error */
 295
 296  error:
 297
 298         SAFE_FREE(cli->inbuf);
 299         SAFE_FREE(cli->outbuf);
 300
 301         if (alloced_cli)
 302                 SAFE_FREE(cli);
 303
 304         return NULL;
 305 }
 306
 307 /****************************************************************************
 308 close the session
 309 ****************************************************************************/
 310
 311 void cli_nt_session_close(struct cli_state *cli)
 312 {
 313         if (cli->ntlmssp_pipe_state) {
 314                 ntlmssp_client_end(&cli->ntlmssp_pipe_state);
 315         }
 316
 317         cli_close(cli, cli->nt_pipe_fnum);
 318         cli->nt_pipe_fnum = 0;
 319         cli->pipe_idx = -1;
 320 }
 321
 322 /****************************************************************************
 323 close the NETLOGON session holding the session key for NETSEC
 324 ****************************************************************************/
 325
 326 void cli_nt_netlogon_netsec_session_close(struct cli_state *cli)
 327 {
 328         if (cli->saved_netlogon_pipe_fnum != 0) {
 329                 cli_close(cli, cli->saved_netlogon_pipe_fnum);
 330                 cli->saved_netlogon_pipe_fnum = 0;
 331         }
 332 }
 333
 334 /****************************************************************************
 335  Close a client connection and free the memory without destroying cli itself.
 336 ****************************************************************************/
 337
 338 void cli_close_connection(struct cli_state *cli)
 339 {
 340         cli_nt_session_close(cli);
 341         cli_nt_netlogon_netsec_session_close(cli);
 342
 343         SAFE_FREE(cli->outbuf);
 344         SAFE_FREE(cli->inbuf);
 345
 346         cli_free_signing_context(cli);
 347         data_blob_free(&cli->secblob);
 348
 349         if (cli->ntlmssp_pipe_state)
 350                 ntlmssp_client_end(&cli->ntlmssp_pipe_state);
 351
 352         if (cli->mem_ctx) {
 353                 talloc_destroy(cli->mem_ctx);
 354                 cli->mem_ctx = NULL;
 355         }
 356
 357         if (cli->fd != -1)
 358                 close(cli->fd);
 359         cli->fd = -1;
 360         cli->smb_rw_error = 0;
 361
 362 }
 363
 364 /****************************************************************************
 365  Shutdown a client structure.
 366 ****************************************************************************/
 367
 368 void cli_shutdown(struct cli_state *cli)
 369 {
 370         BOOL allocated = cli->allocated;
 371         cli_close_connection(cli);
 372         ZERO_STRUCTP(cli);
 373         if (allocated)
 374                 free(cli);
 375 }
 376
 377 /****************************************************************************
 378  Set socket options on a open connection.
 379 ****************************************************************************/
 380
 381 void cli_sockopt(struct cli_state *cli, const char *options)
 382 {
 383         set_socket_options(cli->fd, options);
 384 }
 385
 386 /****************************************************************************
 387  Set the PID to use for smb messages. Return the old pid.
 388 ****************************************************************************/
 389
 390 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 391 {
 392         uint16 ret = cli->pid;
 393         cli->pid = pid;
 394         return ret;
 395 }
 396
 397 /****************************************************************************
 398 Send a keepalive packet to the server
 399 ****************************************************************************/
 400 BOOL cli_send_keepalive(struct cli_state *cli)
 401 {
 402         if (cli->fd == -1) {
 403                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
 404                 return False;
 405         }
 406         if (!send_keepalive(cli->fd)) {
 407                 close(cli->fd);
 408                 cli->fd = -1;
 409                 DEBUG(0,("Error sending keepalive packet to client.\n"));
 410                 return False;
 411         }
 412         return True;
 413 }