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
 212 DEBUG(0,("%s:%s: %p\n", __location__, __FUNCTION__, (void *)fd));
 213         cli->conn = smbXcli_conn_create(cli, fd, remote_name,
 214                                         signing_state,
 215                                         smb1_capabilities,
 216                                         &client_guid,
 217                                         smb2_capabilities);
 218         if (cli->conn == NULL) {
 219                 goto error;
 220         }
 221
 222         cli->smb1.pid = (uint32_t)getpid();
 223         cli->smb1.vc_num = cli->smb1.pid;
 224         cli->smb1.session = smbXcli_session_create(cli, cli->conn);
 225         if (cli->smb1.session == NULL) {
 226                 goto error;
 227         }
 228
 229         cli->initialised = 1;
 230         return cli;
 231
 232         /* Clean up after malloc() error */
 233
 234  error:
 235
 236         TALLOC_FREE(cli);
 237         return NULL;
 238 }
 239
 240 /****************************************************************************
 241  Close all pipes open on this session.
 242 ****************************************************************************/
 243
 244 void cli_nt_pipes_close(struct cli_state *cli)
 245 {
 246         while (cli->pipe_list != NULL) {
 247                 /*
 248                  * No TALLOC_FREE here!
 249                  */
 250                 talloc_free(cli->pipe_list);
 251         }
 252 }
 253
 254 /****************************************************************************
 255  Shutdown a client structure.
 256 ****************************************************************************/
 257
 258 static void _cli_shutdown(struct cli_state *cli)
 259 {
 260         cli_nt_pipes_close(cli);
 261
 262         /*
 263          * tell our peer to free his resources.  Wihtout this, when an
 264          * application attempts to do a graceful shutdown and calls
 265          * smbc_free_context() to clean up all connections, some connections
 266          * can remain active on the peer end, until some (long) timeout period
 267          * later.  This tree disconnect forces the peer to clean up, since the
 268          * connection will be going away.
 269          */
 270         if (cli_state_has_tcon(cli)) {
 271                 cli_tdis(cli);
 272         }
 273
 274         smbXcli_conn_disconnect(cli->conn, NT_STATUS_OK);
 275
 276         TALLOC_FREE(cli);
 277 }
 278
 279 void cli_shutdown(struct cli_state *cli)
 280 {
 281         struct cli_state *cli_head;
 282         if (cli == NULL) {
 283                 return;
 284         }
 285         DLIST_HEAD(cli, cli_head);
 286         if (cli_head == cli) {
 287                 /*
 288                  * head of a DFS list, shutdown all subsidiary DFS
 289                  * connections.
 290                  */
 291                 struct cli_state *p, *next;
 292
 293                 for (p = cli_head->next; p; p = next) {
 294                         next = p->next;
 295                         DLIST_REMOVE(cli_head, p);
 296                         _cli_shutdown(p);
 297                 }
 298         } else {
 299                 DLIST_REMOVE(cli_head, cli);
 300         }
 301
 302         _cli_shutdown(cli);
 303 }
 304
 305 uint16_t cli_state_get_vc_num(struct cli_state *cli)
 306 {
 307         return cli->smb1.vc_num;
 308 }
 309
 310 /****************************************************************************
 311  Set the PID to use for smb messages. Return the old pid.
 312 ****************************************************************************/
 313
 314 uint32_t cli_setpid(struct cli_state *cli, uint32_t pid)
 315 {
 316         uint32_t ret = cli->smb1.pid;
 317         cli->smb1.pid = pid;
 318         return ret;
 319 }
 320
 321 uint32_t cli_getpid(struct cli_state *cli)
 322 {
 323         return cli->smb1.pid;
 324 }
 325
 326 bool cli_state_is_encryption_on(struct cli_state *cli)
 327 {
 328         if (smbXcli_conn_protocol(cli->conn) < PROTOCOL_SMB2_02) {
 329                 return smb1cli_conn_encryption_on(cli->conn);
 330         }
 331
 332         if (cli->smb2.tcon == NULL) {
 333                 return false;
 334         }
 335
 336         return smb2cli_tcon_is_encryption_on(cli->smb2.tcon);
 337 }
 338
 339 bool cli_state_has_tcon(struct cli_state *cli)
 340 {
 341         uint32_t tid;
 342         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 343                 if (cli->smb2.tcon == NULL) {
 344                         return false;
 345                 }
 346                 tid = cli_state_get_tid(cli);
 347                 if (tid == UINT32_MAX) {
 348                         return false;
 349                 }
 350         } else {
 351                 if (cli->smb1.tcon == NULL) {
 352                         return false;
 353                 }
 354                 tid = cli_state_get_tid(cli);
 355                 if (tid == UINT16_MAX) {
 356                         return false;
 357                 }
 358         }
 359         return true;
 360 }
 361
 362 uint32_t cli_state_get_tid(struct cli_state *cli)
 363 {
 364         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 365                 return smb2cli_tcon_current_id(cli->smb2.tcon);
 366         } else {
 367                 return (uint32_t)smb1cli_tcon_current_id(cli->smb1.tcon);
 368         }
 369 }
 370
 371 uint32_t cli_state_set_tid(struct cli_state *cli, uint32_t tid)
 372 {
 373         uint32_t ret;
 374         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 375                 ret = smb2cli_tcon_current_id(cli->smb2.tcon);
 376                 smb2cli_tcon_set_id(cli->smb2.tcon, tid);
 377         } else {
 378                 ret = smb1cli_tcon_current_id(cli->smb1.tcon);
 379                 smb1cli_tcon_set_id(cli->smb1.tcon, tid);
 380         }
 381         return ret;
 382 }
 383
 384 struct smbXcli_tcon *cli_state_save_tcon(struct cli_state *cli)
 385 {
 386         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 387                 return smbXcli_tcon_copy(cli, cli->smb2.tcon);
 388         } else {
 389                 return smbXcli_tcon_copy(cli, cli->smb1.tcon);
 390         }
 391 }
 392
 393 void cli_state_restore_tcon(struct cli_state *cli, struct smbXcli_tcon *tcon)
 394 {
 395         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 396                 TALLOC_FREE(cli->smb2.tcon);
 397                 cli->smb2.tcon = tcon;
 398         } else {
 399                 TALLOC_FREE(cli->smb1.tcon);
 400                 cli->smb1.tcon = tcon;
 401         }
 402 }
 403
 404 uint16_t cli_state_get_uid(struct cli_state *cli)
 405 {
 406         return smb1cli_session_current_id(cli->smb1.session);
 407 }
 408
 409 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
 410 {
 411         uint16_t ret = smb1cli_session_current_id(cli->smb1.session);
 412         smb1cli_session_set_id(cli->smb1.session, uid);
 413         return ret;
 414 }
 415
 416 /****************************************************************************
 417  Set the case sensitivity flag on the packets. Returns old state.
 418 ****************************************************************************/
 419
 420 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 421 {
 422         bool ret;
 423         uint32_t fs_attrs;
 424         struct smbXcli_tcon *tcon;
 425
 426         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 427                 tcon = cli->smb2.tcon;
 428         } else {
 429                 tcon = cli->smb1.tcon;
 430         }
 431
 432         fs_attrs = smbXcli_tcon_get_fs_attributes(tcon);
 433         if (fs_attrs & FILE_CASE_SENSITIVE_SEARCH) {
 434                 ret = true;
 435         } else {
 436                 ret = false;
 437         }
 438         if (case_sensitive) {
 439                 fs_attrs |= FILE_CASE_SENSITIVE_SEARCH;
 440         } else {
 441                 fs_attrs &= ~FILE_CASE_SENSITIVE_SEARCH;
 442         }
 443         smbXcli_tcon_set_fs_attributes(tcon, fs_attrs);
 444
 445         return ret;
 446 }
 447
 448 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
 449 {
 450         uint32_t ret = smb1cli_conn_max_xmit(cli->conn);
 451
 452         if (ofs >= ret) {
 453                 return 0;
 454         }
 455
 456         ret -= ofs;
 457
 458         return ret;
 459 }
 460
 461 time_t cli_state_server_time(struct cli_state *cli)
 462 {
 463         NTTIME nt;
 464         time_t t;
 465
 466         nt = smbXcli_conn_server_system_time(cli->conn);
 467         t = nt_time_to_unix(nt);
 468
 469         return t;
 470 }
 471
 472 struct cli_echo_state {
 473         bool is_smb2;
 474 };
 475
 476 static void cli_echo_done(struct tevent_req *subreq);
 477
 478 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 479                                  struct cli_state *cli, uint16_t num_echos,
 480                                  DATA_BLOB data)
 481 {
 482         struct tevent_req *req, *subreq;
 483         struct cli_echo_state *state;
 484
 485         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 486         if (req == NULL) {
 487                 return NULL;
 488         }
 489
 490         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 491                 state->is_smb2 = true;
 492                 subreq = smb2cli_echo_send(state, ev,
 493                                            cli->conn,
 494                                            cli->timeout);
 495         } else {
 496                 subreq = smb1cli_echo_send(state, ev,
 497                                            cli->conn,
 498                                            cli->timeout,
 499                                            num_echos,
 500                                            data);
 501         }
 502         if (tevent_req_nomem(subreq, req)) {
 503                 return tevent_req_post(req, ev);
 504         }
 505         tevent_req_set_callback(subreq, cli_echo_done, req);
 506
 507         return req;
 508 }
 509
 510 static void cli_echo_done(struct tevent_req *subreq)
 511 {
 512         struct tevent_req *req = tevent_req_callback_data(
 513                 subreq, struct tevent_req);
 514         struct cli_echo_state *state = tevent_req_data(
 515                 req, struct cli_echo_state);
 516         NTSTATUS status;
 517
 518         if (state->is_smb2) {
 519                 status = smb2cli_echo_recv(subreq);
 520         } else {
 521                 status = smb1cli_echo_recv(subreq);
 522         }
 523         TALLOC_FREE(subreq);
 524         if (!NT_STATUS_IS_OK(status)) {
 525                 tevent_req_nterror(req, status);
 526                 return;
 527         }
 528
 529         tevent_req_done(req);
 530 }
 531
 532 /**
 533  * Get the result out from an echo request
 534  * @param[in] req       The async_req from cli_echo_send
 535  * @retval Did the server reply correctly?
 536  */
 537
 538 NTSTATUS cli_echo_recv(struct tevent_req *req)
 539 {
 540         return tevent_req_simple_recv_ntstatus(req);
 541 }
 542
 543 /**
 544  * @brief Send/Receive SMBEcho requests
 545  * @param[in] mem_ctx   The memory context to put the async_req on
 546  * @param[in] ev        The event context that will call us back
 547  * @param[in] cli       The connection to send the echo to
 548  * @param[in] num_echos How many times do we want to get the reply?
 549  * @param[in] data      The data we want to get back
 550  * @retval Did the server reply correctly?
 551  */
 552
 553 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 554 {
 555         TALLOC_CTX *frame = talloc_stackframe();
 556         struct tevent_context *ev;
 557         struct tevent_req *req;
 558         NTSTATUS status = NT_STATUS_OK;
 559
 560         if (smbXcli_conn_has_async_calls(cli->conn)) {
 561                 /*
 562                  * Can't use sync call while an async call is in flight
 563                  */
 564                 status = NT_STATUS_INVALID_PARAMETER;
 565                 goto fail;
 566         }
 567
 568         ev = samba_tevent_context_init(frame);
 569         if (ev == NULL) {
 570                 status = NT_STATUS_NO_MEMORY;
 571                 goto fail;
 572         }
 573
 574         req = cli_echo_send(frame, ev, cli, num_echos, data);
 575         if (req == NULL) {
 576                 status = NT_STATUS_NO_MEMORY;
 577                 goto fail;
 578         }
 579
 580         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 581                 goto fail;
 582         }
 583
 584         status = cli_echo_recv(req);
 585  fail:
 586         TALLOC_FREE(frame);
 587         return status;
 588 }
 589
 590 /**
 591  * Is the SMB command able to hold an AND_X successor
 592  * @param[in] cmd       The SMB command in question
 593  * @retval Can we add a chained request after "cmd"?
 594  */
 595 bool is_andx_req(uint8_t cmd)
 596 {
 597         switch (cmd) {
 598         case SMBtconX:
 599         case SMBlockingX:
 600         case SMBopenX:
 601         case SMBreadX:
 602         case SMBwriteX:
 603         case SMBsesssetupX:
 604         case SMBulogoffX:
 605         case SMBntcreateX:
 606                 return true;
 607                 break;
 608         default:
 609                 break;
 610         }
 611
 612         return false;
 613 }
 614
 615 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 616                  uint8_t smb_command, uint8_t additional_flags,
 617                  uint8_t wct, uint16_t *vwv,
 618                  uint32_t num_bytes, const uint8_t *bytes,
 619                  struct tevent_req **result_parent,
 620                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 621                  uint32_t *pnum_bytes, uint8_t **pbytes)
 622 {
 623         struct tevent_context *ev;
 624         struct tevent_req *req = NULL;
 625         NTSTATUS status = NT_STATUS_NO_MEMORY;
 626
 627         if (smbXcli_conn_has_async_calls(cli->conn)) {
 628                 return NT_STATUS_INVALID_PARAMETER;
 629         }
 630         ev = samba_tevent_context_init(mem_ctx);
 631         if (ev == NULL) {
 632                 goto fail;
 633         }
 634         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags, 0,
 635                            wct, vwv, num_bytes, bytes);
 636         if (req == NULL) {
 637                 goto fail;
 638         }
 639         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 640                 goto fail;
 641         }
 642         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 643                               pnum_bytes, pbytes);
 644 fail:
 645         TALLOC_FREE(ev);
 646         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 647                 *result_parent = req;
 648         }
 649         return status;
 650 }