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