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