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 #include "libsmb/libsmb.h"
  23 #include "../lib/util/tevent_ntstatus.h"
  24 #include "smb_signing.h"
  25 #include "async_smb.h"
  26
  27 /*******************************************************************
  28  Setup the word count and byte count for a client smb message.
  29 ********************************************************************/
  30
  31 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
  32 {
  33         if (zero && (num_words || num_bytes)) {
  34                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
  35         }
  36         SCVAL(buf,smb_wct,num_words);
  37         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
  38         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
  39         return (smb_size + num_words*2 + num_bytes);
  40 }
  41
  42 /****************************************************************************
  43  Change the timeout (in milliseconds).
  44 ****************************************************************************/
  45
  46 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
  47 {
  48         unsigned int old_timeout = cli->timeout;
  49         cli->timeout = timeout;
  50         return old_timeout;
  51 }
  52
  53 /****************************************************************************
  54  Change the port number used to call on.
  55 ****************************************************************************/
  56
  57 void cli_set_port(struct cli_state *cli, int port)
  58 {
  59         cli->port = port;
  60 }
  61
  62 /****************************************************************************
  63  convenience routine to find if we negotiated ucs2
  64 ****************************************************************************/
  65
  66 bool cli_ucs2(struct cli_state *cli)
  67 {
  68         return ((cli->capabilities & CAP_UNICODE) != 0);
  69 }
  70
  71 bool cli_state_seqnum_persistent(struct cli_state *cli,
  72                                  uint16_t mid)
  73 {
  74         struct cli_state_seqnum *c;
  75
  76         for (c = cli->seqnum; c; c = c->next) {
  77                 if (c->mid == mid) {
  78                         c->persistent = true;
  79                         return true;
  80                 }
  81         }
  82
  83         return false;
  84 }
  85
  86 bool cli_state_seqnum_remove(struct cli_state *cli,
  87                              uint16_t mid)
  88 {
  89         struct cli_state_seqnum *c;
  90
  91         for (c = cli->seqnum; c; c = c->next) {
  92                 if (c->mid == mid) {
  93                         DLIST_REMOVE(cli->seqnum, c);
  94                         TALLOC_FREE(c);
  95                         return true;
  96                 }
  97         }
  98
  99         return false;
 100 }
 101
 102 /****************************************************************************
 103  Setup basics in a outgoing packet.
 104 ****************************************************************************/
 105
 106 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
 107 {
 108         uint16 flags2;
 109         cli->rap_error = 0;
 110         SIVAL(buf,smb_rcls,0);
 111         SSVAL(buf,smb_pid,cli->pid);
 112         memset(buf+smb_pidhigh, 0, 12);
 113         SSVAL(buf,smb_uid,cli->vuid);
 114         SSVAL(buf,smb_mid,cli->mid);
 115
 116         if (cli->protocol <= PROTOCOL_CORE) {
 117                 return;
 118         }
 119
 120         if (cli->case_sensitive) {
 121                 SCVAL(buf,smb_flg,0x0);
 122         } else {
 123                 /* Default setting, case insensitive. */
 124                 SCVAL(buf,smb_flg,0x8);
 125         }
 126         flags2 = FLAGS2_LONG_PATH_COMPONENTS;
 127         if (cli->capabilities & CAP_UNICODE)
 128                 flags2 |= FLAGS2_UNICODE_STRINGS;
 129         if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
 130                 flags2 |= FLAGS2_DFS_PATHNAMES;
 131         if (cli->capabilities & CAP_STATUS32)
 132                 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
 133         if (cli->use_spnego)
 134                 flags2 |= FLAGS2_EXTENDED_SECURITY;
 135         SSVAL(buf,smb_flg2, flags2);
 136 }
 137
 138 /****************************************************************************
 139  Initialize Domain, user or password.
 140 ****************************************************************************/
 141
 142 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
 143 {
 144         TALLOC_FREE(cli->domain);
 145         cli->domain = talloc_strdup(cli, domain ? domain : "");
 146         if (cli->domain == NULL) {
 147                 return NT_STATUS_NO_MEMORY;
 148         }
 149         return NT_STATUS_OK;
 150 }
 151
 152 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
 153 {
 154         TALLOC_FREE(cli->user_name);
 155         cli->user_name = talloc_strdup(cli, username ? username : "");
 156         if (cli->user_name == NULL) {
 157                 return NT_STATUS_NO_MEMORY;
 158         }
 159         return NT_STATUS_OK;
 160 }
 161
 162 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
 163 {
 164         TALLOC_FREE(cli->password);
 165
 166         /* Password can be NULL. */
 167         if (password) {
 168                 cli->password = talloc_strdup(cli, password);
 169                 if (cli->password == NULL) {
 170                         return NT_STATUS_NO_MEMORY;
 171                 }
 172         } else {
 173                 /* Use zero NTLMSSP hashes and session key. */
 174                 cli->password = NULL;
 175         }
 176
 177         return NT_STATUS_OK;
 178 }
 179
 180 /****************************************************************************
 181  Initialise credentials of a client structure.
 182 ****************************************************************************/
 183
 184 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
 185 {
 186         NTSTATUS status = cli_set_username(cli, username);
 187         if (!NT_STATUS_IS_OK(status)) {
 188                 return status;
 189         }
 190         status = cli_set_domain(cli, domain);
 191         if (!NT_STATUS_IS_OK(status)) {
 192                 return status;
 193         }
 194         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
 195
 196         return cli_set_password(cli, password);
 197 }
 198
 199 /****************************************************************************
 200  Initialise a client structure. Always returns a talloc'ed struct.
 201  Set the signing state (used from the command line).
 202 ****************************************************************************/
 203
 204 struct cli_state *cli_initialise_ex(int signing_state)
 205 {
 206         struct cli_state *cli = NULL;
 207         bool allow_smb_signing = false;
 208         bool mandatory_signing = false;
 209
 210         /* Check the effective uid - make sure we are not setuid */
 211         if (is_setuid_root()) {
 212                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 213                 return NULL;
 214         }
 215
 216         cli = TALLOC_ZERO_P(NULL, struct cli_state);
 217         if (!cli) {
 218                 return NULL;
 219         }
 220
 221         cli->dfs_mountpoint = talloc_strdup(cli, "");
 222         if (!cli->dfs_mountpoint) {
 223                 goto error;
 224         }
 225         cli->port = 0;
 226         cli->fd = -1;
 227         cli->cnum = -1;
 228         cli->pid = (uint16)sys_getpid();
 229         cli->mid = 1;
 230         cli->vuid = UID_FIELD_INVALID;
 231         cli->protocol = PROTOCOL_NT1;
 232         cli->timeout = 20000; /* Timeout is in milliseconds. */
 233         cli->bufsize = CLI_BUFFER_SIZE+4;
 234         cli->max_xmit = cli->bufsize;
 235         cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 236         cli->seqnum = 0;
 237         cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 238         cli->oplock_handler = cli_oplock_ack;
 239         cli->case_sensitive = false;
 240         cli->smb_rw_error = SMB_READ_OK;
 241
 242         cli->use_spnego = lp_client_use_spnego();
 243
 244         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 245
 246         /* Set the CLI_FORCE_DOSERR environment variable to test
 247            client routines using DOS errors instead of STATUS32
 248            ones.  This intended only as a temporary hack. */
 249         if (getenv("CLI_FORCE_DOSERR"))
 250                 cli->force_dos_errors = true;
 251
 252         if (lp_client_signing()) {
 253                 allow_smb_signing = true;
 254         }
 255
 256         if (lp_client_signing() == Required) {
 257                 mandatory_signing = true;
 258         }
 259
 260         if (signing_state != Undefined) {
 261                 allow_smb_signing = true;
 262         }
 263
 264         if (signing_state == false) {
 265                 allow_smb_signing = false;
 266                 mandatory_signing = false;
 267         }
 268
 269         if (signing_state == Required) {
 270                 mandatory_signing = true;
 271         }
 272
 273         if (!cli->outbuf || !cli->inbuf)
 274                 goto error;
 275
 276         memset(cli->outbuf, 0, cli->bufsize);
 277         memset(cli->inbuf, 0, cli->bufsize);
 278
 279         /* initialise signing */
 280         cli->signing_state = smb_signing_init(cli,
 281                                               allow_smb_signing,
 282                                               mandatory_signing);
 283         if (!cli->signing_state) {
 284                 goto error;
 285         }
 286
 287         cli->outgoing = tevent_queue_create(cli, "cli_outgoing");
 288         if (cli->outgoing == NULL) {
 289                 goto error;
 290         }
 291         cli->pending = NULL;
 292
 293         cli->initialised = 1;
 294
 295         return cli;
 296
 297         /* Clean up after malloc() error */
 298
 299  error:
 300
 301         SAFE_FREE(cli->inbuf);
 302         SAFE_FREE(cli->outbuf);
 303         TALLOC_FREE(cli);
 304         return NULL;
 305 }
 306
 307 struct cli_state *cli_initialise(void)
 308 {
 309         return cli_initialise_ex(Undefined);
 310 }
 311
 312 /****************************************************************************
 313  Close all pipes open on this session.
 314 ****************************************************************************/
 315
 316 void cli_nt_pipes_close(struct cli_state *cli)
 317 {
 318         while (cli->pipe_list != NULL) {
 319                 /*
 320                  * No TALLOC_FREE here!
 321                  */
 322                 talloc_free(cli->pipe_list);
 323         }
 324 }
 325
 326 /****************************************************************************
 327  Shutdown a client structure.
 328 ****************************************************************************/
 329
 330 static void _cli_shutdown(struct cli_state *cli)
 331 {
 332         cli_nt_pipes_close(cli);
 333
 334         /*
 335          * tell our peer to free his resources.  Wihtout this, when an
 336          * application attempts to do a graceful shutdown and calls
 337          * smbc_free_context() to clean up all connections, some connections
 338          * can remain active on the peer end, until some (long) timeout period
 339          * later.  This tree disconnect forces the peer to clean up, since the
 340          * connection will be going away.
 341          *
 342          * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
 343          * the only user for this so far is smbmount which passes opened connection
 344          * down to kernel's smbfs module.
 345          */
 346         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
 347                 cli_tdis(cli);
 348         }
 349
 350         SAFE_FREE(cli->outbuf);
 351         SAFE_FREE(cli->inbuf);
 352
 353         data_blob_free(&cli->secblob);
 354         data_blob_free(&cli->user_session_key);
 355
 356         if (cli->fd != -1) {
 357                 close(cli->fd);
 358         }
 359         cli->fd = -1;
 360         cli->smb_rw_error = SMB_READ_OK;
 361
 362         /*
 363          * Need to free pending first, they remove themselves
 364          */
 365         while (cli->pending) {
 366                 talloc_free(cli->pending[0]);
 367         }
 368         TALLOC_FREE(cli);
 369 }
 370
 371 void cli_shutdown(struct cli_state *cli)
 372 {
 373         struct cli_state *cli_head;
 374         if (cli == NULL) {
 375                 return;
 376         }
 377         DLIST_HEAD(cli, cli_head);
 378         if (cli_head == cli) {
 379                 /*
 380                  * head of a DFS list, shutdown all subsidiary DFS
 381                  * connections.
 382                  */
 383                 struct cli_state *p, *next;
 384
 385                 for (p = cli_head->next; p; p = next) {
 386                         next = p->next;
 387                         DLIST_REMOVE(cli_head, p);
 388                         _cli_shutdown(p);
 389                 }
 390         } else {
 391                 DLIST_REMOVE(cli_head, cli);
 392         }
 393
 394         _cli_shutdown(cli);
 395 }
 396
 397 /****************************************************************************
 398  Set socket options on a open connection.
 399 ****************************************************************************/
 400
 401 void cli_sockopt(struct cli_state *cli, const char *options)
 402 {
 403         set_socket_options(cli->fd, options);
 404 }
 405
 406 /****************************************************************************
 407  Set the PID to use for smb messages. Return the old pid.
 408 ****************************************************************************/
 409
 410 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 411 {
 412         uint16 ret = cli->pid;
 413         cli->pid = pid;
 414         return ret;
 415 }
 416
 417 /****************************************************************************
 418  Set the case sensitivity flag on the packets. Returns old state.
 419 ****************************************************************************/
 420
 421 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 422 {
 423         bool ret = cli->case_sensitive;
 424         cli->case_sensitive = case_sensitive;
 425         return ret;
 426 }
 427
 428 struct cli_echo_state {
 429         uint16_t vwv[1];
 430         DATA_BLOB data;
 431         int num_echos;
 432 };
 433
 434 static void cli_echo_done(struct tevent_req *subreq);
 435
 436 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 437                                  struct cli_state *cli, uint16_t num_echos,
 438                                  DATA_BLOB data)
 439 {
 440         struct tevent_req *req, *subreq;
 441         struct cli_echo_state *state;
 442
 443         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 444         if (req == NULL) {
 445                 return NULL;
 446         }
 447         SSVAL(state->vwv, 0, num_echos);
 448         state->data = data;
 449         state->num_echos = num_echos;
 450
 451         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 452                               data.length, data.data);
 453         if (subreq == NULL) {
 454                 goto fail;
 455         }
 456         tevent_req_set_callback(subreq, cli_echo_done, req);
 457         return req;
 458  fail:
 459         TALLOC_FREE(req);
 460         return NULL;
 461 }
 462
 463 static void cli_echo_done(struct tevent_req *subreq)
 464 {
 465         struct tevent_req *req = tevent_req_callback_data(
 466                 subreq, struct tevent_req);
 467         struct cli_echo_state *state = tevent_req_data(
 468                 req, struct cli_echo_state);
 469         NTSTATUS status;
 470         uint32_t num_bytes;
 471         uint8_t *bytes;
 472         uint8_t *inbuf;
 473
 474         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 475                               &num_bytes, &bytes);
 476         if (!NT_STATUS_IS_OK(status)) {
 477                 tevent_req_nterror(req, status);
 478                 return;
 479         }
 480         if ((num_bytes != state->data.length)
 481             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 482                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 483                 return;
 484         }
 485
 486         state->num_echos -=1;
 487         if (state->num_echos == 0) {
 488                 tevent_req_done(req);
 489                 return;
 490         }
 491
 492         if (!cli_smb_req_set_pending(subreq)) {
 493                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 494                 return;
 495         }
 496 }
 497
 498 /**
 499  * Get the result out from an echo request
 500  * @param[in] req       The async_req from cli_echo_send
 501  * @retval Did the server reply correctly?
 502  */
 503
 504 NTSTATUS cli_echo_recv(struct tevent_req *req)
 505 {
 506         return tevent_req_simple_recv_ntstatus(req);
 507 }
 508
 509 /**
 510  * @brief Send/Receive SMBEcho requests
 511  * @param[in] mem_ctx   The memory context to put the async_req on
 512  * @param[in] ev        The event context that will call us back
 513  * @param[in] cli       The connection to send the echo to
 514  * @param[in] num_echos How many times do we want to get the reply?
 515  * @param[in] data      The data we want to get back
 516  * @retval Did the server reply correctly?
 517  */
 518
 519 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 520 {
 521         TALLOC_CTX *frame = talloc_stackframe();
 522         struct event_context *ev;
 523         struct tevent_req *req;
 524         NTSTATUS status = NT_STATUS_OK;
 525
 526         if (cli_has_async_calls(cli)) {
 527                 /*
 528                  * Can't use sync call while an async call is in flight
 529                  */
 530                 status = NT_STATUS_INVALID_PARAMETER;
 531                 goto fail;
 532         }
 533
 534         ev = event_context_init(frame);
 535         if (ev == NULL) {
 536                 status = NT_STATUS_NO_MEMORY;
 537                 goto fail;
 538         }
 539
 540         req = cli_echo_send(frame, ev, cli, num_echos, data);
 541         if (req == NULL) {
 542                 status = NT_STATUS_NO_MEMORY;
 543                 goto fail;
 544         }
 545
 546         if (!tevent_req_poll(req, ev)) {
 547                 status = map_nt_error_from_unix(errno);
 548                 goto fail;
 549         }
 550
 551         status = cli_echo_recv(req);
 552  fail:
 553         TALLOC_FREE(frame);
 554         if (!NT_STATUS_IS_OK(status)) {
 555                 cli_set_error(cli, status);
 556         }
 557         return status;
 558 }
 559
 560 /**
 561  * Is the SMB command able to hold an AND_X successor
 562  * @param[in] cmd       The SMB command in question
 563  * @retval Can we add a chained request after "cmd"?
 564  */
 565 bool is_andx_req(uint8_t cmd)
 566 {
 567         switch (cmd) {
 568         case SMBtconX:
 569         case SMBlockingX:
 570         case SMBopenX:
 571         case SMBreadX:
 572         case SMBwriteX:
 573         case SMBsesssetupX:
 574         case SMBulogoffX:
 575         case SMBntcreateX:
 576                 return true;
 577                 break;
 578         default:
 579                 break;
 580         }
 581
 582         return false;
 583 }
 584
 585 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 586                  uint8_t smb_command, uint8_t additional_flags,
 587                  uint8_t wct, uint16_t *vwv,
 588                  uint32_t num_bytes, const uint8_t *bytes,
 589                  struct tevent_req **result_parent,
 590                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 591                  uint32_t *pnum_bytes, uint8_t **pbytes)
 592 {
 593         struct tevent_context *ev;
 594         struct tevent_req *req = NULL;
 595         NTSTATUS status = NT_STATUS_NO_MEMORY;
 596
 597         if (cli_has_async_calls(cli)) {
 598                 return NT_STATUS_INVALID_PARAMETER;
 599         }
 600         ev = tevent_context_init(mem_ctx);
 601         if (ev == NULL) {
 602                 goto fail;
 603         }
 604         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 605                            wct, vwv, num_bytes, bytes);
 606         if (req == NULL) {
 607                 goto fail;
 608         }
 609         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 610                 goto fail;
 611         }
 612         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 613                               pnum_bytes, pbytes);
 614 fail:
 615         TALLOC_FREE(ev);
 616         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 617                 *result_parent = req;
 618         }
 619         return status;
 620 }