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