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