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