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_state_protocol(cli) <= 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                                    const char *remote_realm,
 168                                    int signing_state)
 169 {
 170         struct cli_state *cli = NULL;
 171         bool allow_smb_signing = false;
 172         bool mandatory_signing = false;
 173         socklen_t ss_length;
 174         int ret;
 175
 176         /* Check the effective uid - make sure we are not setuid */
 177         if (is_setuid_root()) {
 178                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 179                 return NULL;
 180         }
 181
 182         cli = talloc_zero(mem_ctx, struct cli_state);
 183         if (!cli) {
 184                 return NULL;
 185         }
 186
 187         cli->dfs_mountpoint = talloc_strdup(cli, "");
 188         if (!cli->dfs_mountpoint) {
 189                 goto error;
 190         }
 191         cli->raw_status = NT_STATUS_INTERNAL_ERROR;
 192         cli->protocol = PROTOCOL_NT1;
 193         cli->timeout = 20000; /* Timeout is in milliseconds. */
 194         cli->max_xmit = CLI_BUFFER_SIZE+4;
 195         cli->case_sensitive = false;
 196
 197         cli->use_spnego = lp_client_use_spnego();
 198
 199         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 200
 201         /* Set the CLI_FORCE_DOSERR environment variable to test
 202            client routines using DOS errors instead of STATUS32
 203            ones.  This intended only as a temporary hack. */
 204         if (getenv("CLI_FORCE_DOSERR"))
 205                 cli->force_dos_errors = true;
 206
 207         if (lp_client_signing()) {
 208                 allow_smb_signing = true;
 209         }
 210
 211         if (lp_client_signing() == Required) {
 212                 mandatory_signing = true;
 213         }
 214
 215         if (signing_state != Undefined) {
 216                 allow_smb_signing = true;
 217         }
 218
 219         if (signing_state == false) {
 220                 allow_smb_signing = false;
 221                 mandatory_signing = false;
 222         }
 223
 224         if (signing_state == Required) {
 225                 mandatory_signing = true;
 226         }
 227
 228         /* initialise signing */
 229         cli->signing_state = smb_signing_init(cli,
 230                                               allow_smb_signing,
 231                                               mandatory_signing);
 232         if (!cli->signing_state) {
 233                 goto error;
 234         }
 235
 236         cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
 237         if (cli->conn.outgoing == NULL) {
 238                 goto error;
 239         }
 240         cli->conn.pending = NULL;
 241
 242         cli->conn.remote_name = talloc_strdup(cli, remote_name);
 243         if (cli->conn.remote_name == NULL) {
 244                 goto error;
 245         }
 246
 247         if (remote_realm) {
 248                 cli->conn.remote_realm = talloc_strdup(cli, remote_realm);
 249                 if (cli->conn.remote_realm == NULL) {
 250                         goto error;
 251                 }
 252         }
 253
 254         cli->conn.fd = fd;
 255
 256         ss_length = sizeof(cli->conn.local_ss);
 257         ret = getsockname(fd,
 258                           (struct sockaddr *)(void *)&cli->conn.local_ss,
 259                           &ss_length);
 260         if (ret == -1) {
 261                 goto error;
 262         }
 263         ss_length = sizeof(cli->conn.remote_ss);
 264         ret = getpeername(fd,
 265                           (struct sockaddr *)(void *)&cli->conn.remote_ss,
 266                           &ss_length);
 267         if (ret == -1) {
 268                 goto error;
 269         }
 270
 271         cli->smb1.mid = 1;
 272         cli->smb1.pid = (uint16_t)sys_getpid();
 273         cli->smb1.vc_num = cli->smb1.pid;
 274         cli->smb1.tid = UINT16_MAX;
 275         cli->smb1.uid = UID_FIELD_INVALID;
 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 bool cli_state_encryption_on(struct cli_state *cli)
 289 {
 290         return common_encryption_on(cli->trans_enc_state);
 291 }
 292
 293
 294 /****************************************************************************
 295  Close all pipes open on this session.
 296 ****************************************************************************/
 297
 298 void cli_nt_pipes_close(struct cli_state *cli)
 299 {
 300         while (cli->pipe_list != NULL) {
 301                 /*
 302                  * No TALLOC_FREE here!
 303                  */
 304                 talloc_free(cli->pipe_list);
 305         }
 306 }
 307
 308 /****************************************************************************
 309  Shutdown a client structure.
 310 ****************************************************************************/
 311
 312 static void _cli_shutdown(struct cli_state *cli)
 313 {
 314         cli_nt_pipes_close(cli);
 315
 316         /*
 317          * tell our peer to free his resources.  Wihtout this, when an
 318          * application attempts to do a graceful shutdown and calls
 319          * smbc_free_context() to clean up all connections, some connections
 320          * can remain active on the peer end, until some (long) timeout period
 321          * later.  This tree disconnect forces the peer to clean up, since the
 322          * connection will be going away.
 323          */
 324         if (cli_state_has_tcon(cli)) {
 325                 cli_tdis(cli);
 326         }
 327
 328         data_blob_free(&cli->secblob);
 329         data_blob_free(&cli->user_session_key);
 330
 331         cli_state_disconnect(cli);
 332
 333         /*
 334          * Need to free pending first, they remove themselves
 335          */
 336         while (cli->conn.pending) {
 337                 talloc_free(cli->conn.pending[0]);
 338         }
 339         TALLOC_FREE(cli);
 340 }
 341
 342 void cli_shutdown(struct cli_state *cli)
 343 {
 344         struct cli_state *cli_head;
 345         if (cli == NULL) {
 346                 return;
 347         }
 348         DLIST_HEAD(cli, cli_head);
 349         if (cli_head == cli) {
 350                 /*
 351                  * head of a DFS list, shutdown all subsidiary DFS
 352                  * connections.
 353                  */
 354                 struct cli_state *p, *next;
 355
 356                 for (p = cli_head->next; p; p = next) {
 357                         next = p->next;
 358                         DLIST_REMOVE(cli_head, p);
 359                         _cli_shutdown(p);
 360                 }
 361         } else {
 362                 DLIST_REMOVE(cli_head, cli);
 363         }
 364
 365         _cli_shutdown(cli);
 366 }
 367
 368 /****************************************************************************
 369  Set socket options on a open connection.
 370 ****************************************************************************/
 371
 372 void cli_sockopt(struct cli_state *cli, const char *options)
 373 {
 374         set_socket_options(cli->conn.fd, options);
 375 }
 376
 377 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
 378 {
 379         return &cli->conn.local_ss;
 380 }
 381
 382 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
 383 {
 384         return &cli->conn.remote_ss;
 385 }
 386
 387 const char *cli_state_remote_name(struct cli_state *cli)
 388 {
 389         return cli->conn.remote_name;
 390 }
 391
 392 const char *cli_state_remote_realm(struct cli_state *cli)
 393 {
 394         return cli->conn.remote_realm;
 395 }
 396
 397 uint16_t cli_state_get_vc_num(struct cli_state *cli)
 398 {
 399         return cli->smb1.vc_num;
 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 cli->protocol;
 465 }
 466
 467 uint32_t cli_state_capabilities(struct cli_state *cli)
 468 {
 469         return cli->capabilities;
 470 }
 471
 472 struct cli_echo_state {
 473         uint16_t vwv[1];
 474         DATA_BLOB data;
 475         int num_echos;
 476 };
 477
 478 static void cli_echo_done(struct tevent_req *subreq);
 479
 480 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 481                                  struct cli_state *cli, uint16_t num_echos,
 482                                  DATA_BLOB data)
 483 {
 484         struct tevent_req *req, *subreq;
 485         struct cli_echo_state *state;
 486
 487         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 488         if (req == NULL) {
 489                 return NULL;
 490         }
 491         SSVAL(state->vwv, 0, num_echos);
 492         state->data = data;
 493         state->num_echos = num_echos;
 494
 495         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 496                               data.length, data.data);
 497         if (subreq == NULL) {
 498                 goto fail;
 499         }
 500         tevent_req_set_callback(subreq, cli_echo_done, req);
 501         return req;
 502  fail:
 503         TALLOC_FREE(req);
 504         return NULL;
 505 }
 506
 507 static void cli_echo_done(struct tevent_req *subreq)
 508 {
 509         struct tevent_req *req = tevent_req_callback_data(
 510                 subreq, struct tevent_req);
 511         struct cli_echo_state *state = tevent_req_data(
 512                 req, struct cli_echo_state);
 513         NTSTATUS status;
 514         uint32_t num_bytes;
 515         uint8_t *bytes;
 516         uint8_t *inbuf;
 517
 518         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 519                               &num_bytes, &bytes);
 520         if (!NT_STATUS_IS_OK(status)) {
 521                 tevent_req_nterror(req, status);
 522                 return;
 523         }
 524         if ((num_bytes != state->data.length)
 525             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 526                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 527                 return;
 528         }
 529
 530         state->num_echos -=1;
 531         if (state->num_echos == 0) {
 532                 tevent_req_done(req);
 533                 return;
 534         }
 535
 536         if (!cli_smb_req_set_pending(subreq)) {
 537                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 538                 return;
 539         }
 540 }
 541
 542 /**
 543  * Get the result out from an echo request
 544  * @param[in] req       The async_req from cli_echo_send
 545  * @retval Did the server reply correctly?
 546  */
 547
 548 NTSTATUS cli_echo_recv(struct tevent_req *req)
 549 {
 550         return tevent_req_simple_recv_ntstatus(req);
 551 }
 552
 553 /**
 554  * @brief Send/Receive SMBEcho requests
 555  * @param[in] mem_ctx   The memory context to put the async_req on
 556  * @param[in] ev        The event context that will call us back
 557  * @param[in] cli       The connection to send the echo to
 558  * @param[in] num_echos How many times do we want to get the reply?
 559  * @param[in] data      The data we want to get back
 560  * @retval Did the server reply correctly?
 561  */
 562
 563 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 564 {
 565         TALLOC_CTX *frame = talloc_stackframe();
 566         struct event_context *ev;
 567         struct tevent_req *req;
 568         NTSTATUS status = NT_STATUS_OK;
 569
 570         if (cli_has_async_calls(cli)) {
 571                 /*
 572                  * Can't use sync call while an async call is in flight
 573                  */
 574                 status = NT_STATUS_INVALID_PARAMETER;
 575                 goto fail;
 576         }
 577
 578         ev = event_context_init(frame);
 579         if (ev == NULL) {
 580                 status = NT_STATUS_NO_MEMORY;
 581                 goto fail;
 582         }
 583
 584         req = cli_echo_send(frame, ev, cli, num_echos, data);
 585         if (req == NULL) {
 586                 status = NT_STATUS_NO_MEMORY;
 587                 goto fail;
 588         }
 589
 590         if (!tevent_req_poll(req, ev)) {
 591                 status = map_nt_error_from_unix(errno);
 592                 goto fail;
 593         }
 594
 595         status = cli_echo_recv(req);
 596  fail:
 597         TALLOC_FREE(frame);
 598         return status;
 599 }
 600
 601 /**
 602  * Is the SMB command able to hold an AND_X successor
 603  * @param[in] cmd       The SMB command in question
 604  * @retval Can we add a chained request after "cmd"?
 605  */
 606 bool is_andx_req(uint8_t cmd)
 607 {
 608         switch (cmd) {
 609         case SMBtconX:
 610         case SMBlockingX:
 611         case SMBopenX:
 612         case SMBreadX:
 613         case SMBwriteX:
 614         case SMBsesssetupX:
 615         case SMBulogoffX:
 616         case SMBntcreateX:
 617                 return true;
 618                 break;
 619         default:
 620                 break;
 621         }
 622
 623         return false;
 624 }
 625
 626 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 627                  uint8_t smb_command, uint8_t additional_flags,
 628                  uint8_t wct, uint16_t *vwv,
 629                  uint32_t num_bytes, const uint8_t *bytes,
 630                  struct tevent_req **result_parent,
 631                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 632                  uint32_t *pnum_bytes, uint8_t **pbytes)
 633 {
 634         struct tevent_context *ev;
 635         struct tevent_req *req = NULL;
 636         NTSTATUS status = NT_STATUS_NO_MEMORY;
 637
 638         if (cli_has_async_calls(cli)) {
 639                 return NT_STATUS_INVALID_PARAMETER;
 640         }
 641         ev = tevent_context_init(mem_ctx);
 642         if (ev == NULL) {
 643                 goto fail;
 644         }
 645         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 646                            wct, vwv, num_bytes, bytes);
 647         if (req == NULL) {
 648                 goto fail;
 649         }
 650         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 651                 goto fail;
 652         }
 653         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 654                               pnum_bytes, pbytes);
 655 fail:
 656         TALLOC_FREE(ev);
 657         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 658                 *result_parent = req;
 659         }
 660         return status;
 661 }