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