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