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 "smb_signing.h"
  25 #include "async_smb.h"
  26
  27 /*******************************************************************
  28  Setup the word count and byte count for a client smb message.
  29 ********************************************************************/
  30
  31 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
  32 {
  33         if (zero && (num_words || num_bytes)) {
  34                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
  35         }
  36         SCVAL(buf,smb_wct,num_words);
  37         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
  38         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
  39         return (smb_size + num_words*2 + num_bytes);
  40 }
  41
  42 /****************************************************************************
  43  Change the timeout (in milliseconds).
  44 ****************************************************************************/
  45
  46 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
  47 {
  48         unsigned int old_timeout = cli->timeout;
  49         cli->timeout = timeout;
  50         return old_timeout;
  51 }
  52
  53 /****************************************************************************
  54  convenience routine to find if we negotiated ucs2
  55 ****************************************************************************/
  56
  57 bool cli_ucs2(struct cli_state *cli)
  58 {
  59         return ((cli_state_capabilities(cli) & CAP_UNICODE) != 0);
  60 }
  61
  62 /****************************************************************************
  63  Setup basics in a outgoing packet.
  64 ****************************************************************************/
  65
  66 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
  67 {
  68         uint16 flags2;
  69         cli->rap_error = 0;
  70         SIVAL(buf,smb_rcls,0);
  71         SSVAL(buf,smb_pid,cli->smb1.pid);
  72         memset(buf+smb_pidhigh, 0, 12);
  73         SSVAL(buf,smb_uid, cli_state_get_uid(cli));
  74         SSVAL(buf,smb_mid,cli->smb1.mid);
  75
  76         if (cli->protocol <= PROTOCOL_CORE) {
  77                 return;
  78         }
  79
  80         if (cli->case_sensitive) {
  81                 SCVAL(buf,smb_flg,0x0);
  82         } else {
  83                 /* Default setting, case insensitive. */
  84                 SCVAL(buf,smb_flg,0x8);
  85         }
  86         flags2 = FLAGS2_LONG_PATH_COMPONENTS;
  87         if (cli_state_capabilities(cli) & CAP_UNICODE)
  88                 flags2 |= FLAGS2_UNICODE_STRINGS;
  89         if ((cli_state_capabilities(cli) & CAP_DFS) && cli->dfsroot)
  90                 flags2 |= FLAGS2_DFS_PATHNAMES;
  91         if (cli_state_capabilities(cli) & CAP_STATUS32)
  92                 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
  93         if (cli->use_spnego)
  94                 flags2 |= FLAGS2_EXTENDED_SECURITY;
  95         SSVAL(buf,smb_flg2, flags2);
  96 }
  97
  98 /****************************************************************************
  99  Initialize Domain, user or password.
 100 ****************************************************************************/
 101
 102 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
 103 {
 104         TALLOC_FREE(cli->domain);
 105         cli->domain = talloc_strdup(cli, domain ? domain : "");
 106         if (cli->domain == NULL) {
 107                 return NT_STATUS_NO_MEMORY;
 108         }
 109         return NT_STATUS_OK;
 110 }
 111
 112 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
 113 {
 114         TALLOC_FREE(cli->user_name);
 115         cli->user_name = talloc_strdup(cli, username ? username : "");
 116         if (cli->user_name == NULL) {
 117                 return NT_STATUS_NO_MEMORY;
 118         }
 119         return NT_STATUS_OK;
 120 }
 121
 122 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
 123 {
 124         TALLOC_FREE(cli->password);
 125
 126         /* Password can be NULL. */
 127         if (password) {
 128                 cli->password = talloc_strdup(cli, password);
 129                 if (cli->password == NULL) {
 130                         return NT_STATUS_NO_MEMORY;
 131                 }
 132         } else {
 133                 /* Use zero NTLMSSP hashes and session key. */
 134                 cli->password = NULL;
 135         }
 136
 137         return NT_STATUS_OK;
 138 }
 139
 140 /****************************************************************************
 141  Initialise credentials of a client structure.
 142 ****************************************************************************/
 143
 144 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
 145 {
 146         NTSTATUS status = cli_set_username(cli, username);
 147         if (!NT_STATUS_IS_OK(status)) {
 148                 return status;
 149         }
 150         status = cli_set_domain(cli, domain);
 151         if (!NT_STATUS_IS_OK(status)) {
 152                 return status;
 153         }
 154         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
 155
 156         return cli_set_password(cli, password);
 157 }
 158
 159 /****************************************************************************
 160  Initialise a client structure. Always returns a talloc'ed struct.
 161  Set the signing state (used from the command line).
 162 ****************************************************************************/
 163
 164 struct cli_state *cli_state_create(TALLOC_CTX *mem_ctx,
 165                                    int fd,
 166                                    const char *remote_name,
 167                                    int signing_state)
 168 {
 169         struct cli_state *cli = NULL;
 170         bool allow_smb_signing = false;
 171         bool mandatory_signing = false;
 172         socklen_t ss_length;
 173         int ret;
 174
 175         /* Check the effective uid - make sure we are not setuid */
 176         if (is_setuid_root()) {
 177                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 178                 return NULL;
 179         }
 180
 181         cli = talloc_zero(mem_ctx, struct cli_state);
 182         if (!cli) {
 183                 return NULL;
 184         }
 185
 186         cli->dfs_mountpoint = talloc_strdup(cli, "");
 187         if (!cli->dfs_mountpoint) {
 188                 goto error;
 189         }
 190         cli->raw_status = NT_STATUS_INTERNAL_ERROR;
 191         cli->protocol = PROTOCOL_NT1;
 192         cli->timeout = 20000; /* Timeout is in milliseconds. */
 193         cli->max_xmit = CLI_BUFFER_SIZE+4;
 194         cli->case_sensitive = false;
 195
 196         cli->use_spnego = lp_client_use_spnego();
 197
 198         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 199
 200         /* Set the CLI_FORCE_DOSERR environment variable to test
 201            client routines using DOS errors instead of STATUS32
 202            ones.  This intended only as a temporary hack. */
 203         if (getenv("CLI_FORCE_DOSERR"))
 204                 cli->force_dos_errors = true;
 205
 206         if (lp_client_signing()) {
 207                 allow_smb_signing = true;
 208         }
 209
 210         if (lp_client_signing() == Required) {
 211                 mandatory_signing = true;
 212         }
 213
 214         if (signing_state != Undefined) {
 215                 allow_smb_signing = true;
 216         }
 217
 218         if (signing_state == false) {
 219                 allow_smb_signing = false;
 220                 mandatory_signing = false;
 221         }
 222
 223         if (signing_state == Required) {
 224                 mandatory_signing = true;
 225         }
 226
 227         /* initialise signing */
 228         cli->signing_state = smb_signing_init(cli,
 229                                               allow_smb_signing,
 230                                               mandatory_signing);
 231         if (!cli->signing_state) {
 232                 goto error;
 233         }
 234
 235         cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
 236         if (cli->conn.outgoing == NULL) {
 237                 goto error;
 238         }
 239         cli->conn.pending = NULL;
 240
 241         cli->conn.remote_name = talloc_strdup(cli, remote_name);
 242         if (cli->conn.remote_name == NULL) {
 243                 goto error;
 244         }
 245
 246         cli->conn.fd = fd;
 247
 248         ss_length = sizeof(cli->conn.local_ss);
 249         ret = getsockname(fd,
 250                           (struct sockaddr *)(void *)&cli->conn.local_ss,
 251                           &ss_length);
 252         if (ret == -1) {
 253                 goto error;
 254         }
 255         ss_length = sizeof(cli->conn.remote_ss);
 256         ret = getpeername(fd,
 257                           (struct sockaddr *)(void *)&cli->conn.remote_ss,
 258                           &ss_length);
 259         if (ret == -1) {
 260                 goto error;
 261         }
 262
 263         cli->smb1.mid = 1;
 264         cli->smb1.pid = (uint16_t)sys_getpid();
 265         cli->smb1.vc_num = cli->smb1.pid;
 266         cli->smb1.tid = UINT16_MAX;
 267         cli->smb1.uid = UID_FIELD_INVALID;
 268
 269         cli->initialised = 1;
 270         return cli;
 271
 272         /* Clean up after malloc() error */
 273
 274  error:
 275
 276         TALLOC_FREE(cli);
 277         return NULL;
 278 }
 279
 280 bool cli_state_encryption_on(struct cli_state *cli)
 281 {
 282         return common_encryption_on(cli->trans_enc_state);
 283 }
 284
 285
 286 /****************************************************************************
 287  Close all pipes open on this session.
 288 ****************************************************************************/
 289
 290 void cli_nt_pipes_close(struct cli_state *cli)
 291 {
 292         while (cli->pipe_list != NULL) {
 293                 /*
 294                  * No TALLOC_FREE here!
 295                  */
 296                 talloc_free(cli->pipe_list);
 297         }
 298 }
 299
 300 /****************************************************************************
 301  Shutdown a client structure.
 302 ****************************************************************************/
 303
 304 static void _cli_shutdown(struct cli_state *cli)
 305 {
 306         cli_nt_pipes_close(cli);
 307
 308         /*
 309          * tell our peer to free his resources.  Wihtout this, when an
 310          * application attempts to do a graceful shutdown and calls
 311          * smbc_free_context() to clean up all connections, some connections
 312          * can remain active on the peer end, until some (long) timeout period
 313          * later.  This tree disconnect forces the peer to clean up, since the
 314          * connection will be going away.
 315          */
 316         if (cli_state_has_tcon(cli)) {
 317                 cli_tdis(cli);
 318         }
 319
 320         data_blob_free(&cli->secblob);
 321         data_blob_free(&cli->user_session_key);
 322
 323         cli_state_disconnect(cli);
 324
 325         /*
 326          * Need to free pending first, they remove themselves
 327          */
 328         while (cli->conn.pending) {
 329                 talloc_free(cli->conn.pending[0]);
 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 /****************************************************************************
 361  Set socket options on a open connection.
 362 ****************************************************************************/
 363
 364 void cli_sockopt(struct cli_state *cli, const char *options)
 365 {
 366         set_socket_options(cli->conn.fd, options);
 367 }
 368
 369 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
 370 {
 371         return &cli->conn.local_ss;
 372 }
 373
 374 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
 375 {
 376         return &cli->conn.remote_ss;
 377 }
 378
 379 const char *cli_state_remote_name(struct cli_state *cli)
 380 {
 381         return cli->conn.remote_name;
 382 }
 383
 384 uint16_t cli_state_get_vc_num(struct cli_state *cli)
 385 {
 386         return cli->smb1.vc_num;
 387 }
 388
 389 /****************************************************************************
 390  Set the PID to use for smb messages. Return the old pid.
 391 ****************************************************************************/
 392
 393 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 394 {
 395         uint16_t ret = cli->smb1.pid;
 396         cli->smb1.pid = pid;
 397         return ret;
 398 }
 399
 400 uint16_t cli_getpid(struct cli_state *cli)
 401 {
 402         return cli->smb1.pid;
 403 }
 404
 405 bool cli_state_has_tcon(struct cli_state *cli)
 406 {
 407         if (cli->smb1.tid == UINT16_MAX) {
 408                 return false;
 409         }
 410
 411         return true;
 412 }
 413
 414 uint16_t cli_state_get_tid(struct cli_state *cli)
 415 {
 416         return cli->smb1.tid;
 417 }
 418
 419 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
 420 {
 421         uint16_t ret = cli->smb1.tid;
 422         cli->smb1.tid = tid;
 423         return ret;
 424 }
 425
 426 uint16_t cli_state_get_uid(struct cli_state *cli)
 427 {
 428         return cli->smb1.uid;
 429 }
 430
 431 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
 432 {
 433         uint16_t ret = cli->smb1.uid;
 434         cli->smb1.uid = uid;
 435         return ret;
 436 }
 437
 438 /****************************************************************************
 439  Set the case sensitivity flag on the packets. Returns old state.
 440 ****************************************************************************/
 441
 442 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 443 {
 444         bool ret = cli->case_sensitive;
 445         cli->case_sensitive = case_sensitive;
 446         return ret;
 447 }
 448
 449 uint32_t cli_state_capabilities(struct cli_state *cli)
 450 {
 451         return cli->capabilities;
 452 }
 453
 454 struct cli_echo_state {
 455         uint16_t vwv[1];
 456         DATA_BLOB data;
 457         int num_echos;
 458 };
 459
 460 static void cli_echo_done(struct tevent_req *subreq);
 461
 462 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 463                                  struct cli_state *cli, uint16_t num_echos,
 464                                  DATA_BLOB data)
 465 {
 466         struct tevent_req *req, *subreq;
 467         struct cli_echo_state *state;
 468
 469         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 470         if (req == NULL) {
 471                 return NULL;
 472         }
 473         SSVAL(state->vwv, 0, num_echos);
 474         state->data = data;
 475         state->num_echos = num_echos;
 476
 477         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 478                               data.length, data.data);
 479         if (subreq == NULL) {
 480                 goto fail;
 481         }
 482         tevent_req_set_callback(subreq, cli_echo_done, req);
 483         return req;
 484  fail:
 485         TALLOC_FREE(req);
 486         return NULL;
 487 }
 488
 489 static void cli_echo_done(struct tevent_req *subreq)
 490 {
 491         struct tevent_req *req = tevent_req_callback_data(
 492                 subreq, struct tevent_req);
 493         struct cli_echo_state *state = tevent_req_data(
 494                 req, struct cli_echo_state);
 495         NTSTATUS status;
 496         uint32_t num_bytes;
 497         uint8_t *bytes;
 498         uint8_t *inbuf;
 499
 500         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 501                               &num_bytes, &bytes);
 502         if (!NT_STATUS_IS_OK(status)) {
 503                 tevent_req_nterror(req, status);
 504                 return;
 505         }
 506         if ((num_bytes != state->data.length)
 507             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 508                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 509                 return;
 510         }
 511
 512         state->num_echos -=1;
 513         if (state->num_echos == 0) {
 514                 tevent_req_done(req);
 515                 return;
 516         }
 517
 518         if (!cli_smb_req_set_pending(subreq)) {
 519                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 520                 return;
 521         }
 522 }
 523
 524 /**
 525  * Get the result out from an echo request
 526  * @param[in] req       The async_req from cli_echo_send
 527  * @retval Did the server reply correctly?
 528  */
 529
 530 NTSTATUS cli_echo_recv(struct tevent_req *req)
 531 {
 532         return tevent_req_simple_recv_ntstatus(req);
 533 }
 534
 535 /**
 536  * @brief Send/Receive SMBEcho requests
 537  * @param[in] mem_ctx   The memory context to put the async_req on
 538  * @param[in] ev        The event context that will call us back
 539  * @param[in] cli       The connection to send the echo to
 540  * @param[in] num_echos How many times do we want to get the reply?
 541  * @param[in] data      The data we want to get back
 542  * @retval Did the server reply correctly?
 543  */
 544
 545 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 546 {
 547         TALLOC_CTX *frame = talloc_stackframe();
 548         struct event_context *ev;
 549         struct tevent_req *req;
 550         NTSTATUS status = NT_STATUS_OK;
 551
 552         if (cli_has_async_calls(cli)) {
 553                 /*
 554                  * Can't use sync call while an async call is in flight
 555                  */
 556                 status = NT_STATUS_INVALID_PARAMETER;
 557                 goto fail;
 558         }
 559
 560         ev = event_context_init(frame);
 561         if (ev == NULL) {
 562                 status = NT_STATUS_NO_MEMORY;
 563                 goto fail;
 564         }
 565
 566         req = cli_echo_send(frame, ev, cli, num_echos, data);
 567         if (req == NULL) {
 568                 status = NT_STATUS_NO_MEMORY;
 569                 goto fail;
 570         }
 571
 572         if (!tevent_req_poll(req, ev)) {
 573                 status = map_nt_error_from_unix(errno);
 574                 goto fail;
 575         }
 576
 577         status = cli_echo_recv(req);
 578  fail:
 579         TALLOC_FREE(frame);
 580         return status;
 581 }
 582
 583 /**
 584  * Is the SMB command able to hold an AND_X successor
 585  * @param[in] cmd       The SMB command in question
 586  * @retval Can we add a chained request after "cmd"?
 587  */
 588 bool is_andx_req(uint8_t cmd)
 589 {
 590         switch (cmd) {
 591         case SMBtconX:
 592         case SMBlockingX:
 593         case SMBopenX:
 594         case SMBreadX:
 595         case SMBwriteX:
 596         case SMBsesssetupX:
 597         case SMBulogoffX:
 598         case SMBntcreateX:
 599                 return true;
 600                 break;
 601         default:
 602                 break;
 603         }
 604
 605         return false;
 606 }
 607
 608 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 609                  uint8_t smb_command, uint8_t additional_flags,
 610                  uint8_t wct, uint16_t *vwv,
 611                  uint32_t num_bytes, const uint8_t *bytes,
 612                  struct tevent_req **result_parent,
 613                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 614                  uint32_t *pnum_bytes, uint8_t **pbytes)
 615 {
 616         struct tevent_context *ev;
 617         struct tevent_req *req = NULL;
 618         NTSTATUS status = NT_STATUS_NO_MEMORY;
 619
 620         if (cli_has_async_calls(cli)) {
 621                 return NT_STATUS_INVALID_PARAMETER;
 622         }
 623         ev = tevent_context_init(mem_ctx);
 624         if (ev == NULL) {
 625                 goto fail;
 626         }
 627         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 628                            wct, vwv, num_bytes, bytes);
 629         if (req == NULL) {
 630                 goto fail;
 631         }
 632         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 633                 goto fail;
 634         }
 635         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 636                               pnum_bytes, pbytes);
 637 fail:
 638         TALLOC_FREE(ev);
 639         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 640                 *result_parent = req;
 641         }
 642         return status;
 643 }