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