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