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