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