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->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
 205         cli->oplock_handler = cli_oplock_ack;
 206         cli->case_sensitive = false;
 207         cli->smb_rw_error = SMB_READ_OK;
 208
 209         cli->use_spnego = lp_client_use_spnego();
 210
 211         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 212
 213         /* Set the CLI_FORCE_DOSERR environment variable to test
 214            client routines using DOS errors instead of STATUS32
 215            ones.  This intended only as a temporary hack. */
 216         if (getenv("CLI_FORCE_DOSERR"))
 217                 cli->force_dos_errors = true;
 218
 219         if (lp_client_signing()) {
 220                 allow_smb_signing = true;
 221         }
 222
 223         if (lp_client_signing() == Required) {
 224                 mandatory_signing = true;
 225         }
 226
 227         if (signing_state != Undefined) {
 228                 allow_smb_signing = true;
 229         }
 230
 231         if (signing_state == false) {
 232                 allow_smb_signing = false;
 233                 mandatory_signing = false;
 234         }
 235
 236         if (signing_state == Required) {
 237                 mandatory_signing = true;
 238         }
 239
 240         if (!cli->inbuf)
 241                 goto error;
 242
 243         memset(cli->inbuf, 0, cli->bufsize);
 244
 245         /* initialise signing */
 246         cli->signing_state = smb_signing_init(cli,
 247                                               allow_smb_signing,
 248                                               mandatory_signing);
 249         if (!cli->signing_state) {
 250                 goto error;
 251         }
 252
 253         cli->outgoing = tevent_queue_create(cli, "cli_outgoing");
 254         if (cli->outgoing == NULL) {
 255                 goto error;
 256         }
 257         cli->pending = NULL;
 258
 259         cli->initialised = 1;
 260
 261         return cli;
 262
 263         /* Clean up after malloc() error */
 264
 265  error:
 266
 267         SAFE_FREE(cli->inbuf);
 268         TALLOC_FREE(cli);
 269         return NULL;
 270 }
 271
 272 struct cli_state *cli_initialise(void)
 273 {
 274         return cli_initialise_ex(Undefined);
 275 }
 276
 277 /****************************************************************************
 278  Close all pipes open on this session.
 279 ****************************************************************************/
 280
 281 void cli_nt_pipes_close(struct cli_state *cli)
 282 {
 283         while (cli->pipe_list != NULL) {
 284                 /*
 285                  * No TALLOC_FREE here!
 286                  */
 287                 talloc_free(cli->pipe_list);
 288         }
 289 }
 290
 291 /****************************************************************************
 292  Shutdown a client structure.
 293 ****************************************************************************/
 294
 295 static void _cli_shutdown(struct cli_state *cli)
 296 {
 297         cli_nt_pipes_close(cli);
 298
 299         /*
 300          * tell our peer to free his resources.  Wihtout this, when an
 301          * application attempts to do a graceful shutdown and calls
 302          * smbc_free_context() to clean up all connections, some connections
 303          * can remain active on the peer end, until some (long) timeout period
 304          * later.  This tree disconnect forces the peer to clean up, since the
 305          * connection will be going away.
 306          *
 307          * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
 308          * the only user for this so far is smbmount which passes opened connection
 309          * down to kernel's smbfs module.
 310          */
 311         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
 312                 cli_tdis(cli);
 313         }
 314
 315         SAFE_FREE(cli->inbuf);
 316
 317         data_blob_free(&cli->secblob);
 318         data_blob_free(&cli->user_session_key);
 319
 320         if (cli->fd != -1) {
 321                 close(cli->fd);
 322         }
 323         cli->fd = -1;
 324         cli->smb_rw_error = SMB_READ_OK;
 325
 326         /*
 327          * Need to free pending first, they remove themselves
 328          */
 329         while (cli->pending) {
 330                 talloc_free(cli->pending[0]);
 331         }
 332         TALLOC_FREE(cli);
 333 }
 334
 335 void cli_shutdown(struct cli_state *cli)
 336 {
 337         struct cli_state *cli_head;
 338         if (cli == NULL) {
 339                 return;
 340         }
 341         DLIST_HEAD(cli, cli_head);
 342         if (cli_head == cli) {
 343                 /*
 344                  * head of a DFS list, shutdown all subsidiary DFS
 345                  * connections.
 346                  */
 347                 struct cli_state *p, *next;
 348
 349                 for (p = cli_head->next; p; p = next) {
 350                         next = p->next;
 351                         DLIST_REMOVE(cli_head, p);
 352                         _cli_shutdown(p);
 353                 }
 354         } else {
 355                 DLIST_REMOVE(cli_head, cli);
 356         }
 357
 358         _cli_shutdown(cli);
 359 }
 360
 361 /****************************************************************************
 362  Set socket options on a open connection.
 363 ****************************************************************************/
 364
 365 void cli_sockopt(struct cli_state *cli, const char *options)
 366 {
 367         set_socket_options(cli->fd, options);
 368 }
 369
 370 /****************************************************************************
 371  Set the PID to use for smb messages. Return the old pid.
 372 ****************************************************************************/
 373
 374 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 375 {
 376         uint16 ret = cli->pid;
 377         cli->pid = pid;
 378         return ret;
 379 }
 380
 381 /****************************************************************************
 382  Set the case sensitivity flag on the packets. Returns old state.
 383 ****************************************************************************/
 384
 385 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 386 {
 387         bool ret = cli->case_sensitive;
 388         cli->case_sensitive = case_sensitive;
 389         return ret;
 390 }
 391
 392 struct cli_echo_state {
 393         uint16_t vwv[1];
 394         DATA_BLOB data;
 395         int num_echos;
 396 };
 397
 398 static void cli_echo_done(struct tevent_req *subreq);
 399
 400 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 401                                  struct cli_state *cli, uint16_t num_echos,
 402                                  DATA_BLOB data)
 403 {
 404         struct tevent_req *req, *subreq;
 405         struct cli_echo_state *state;
 406
 407         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 408         if (req == NULL) {
 409                 return NULL;
 410         }
 411         SSVAL(state->vwv, 0, num_echos);
 412         state->data = data;
 413         state->num_echos = num_echos;
 414
 415         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 416                               data.length, data.data);
 417         if (subreq == NULL) {
 418                 goto fail;
 419         }
 420         tevent_req_set_callback(subreq, cli_echo_done, req);
 421         return req;
 422  fail:
 423         TALLOC_FREE(req);
 424         return NULL;
 425 }
 426
 427 static void cli_echo_done(struct tevent_req *subreq)
 428 {
 429         struct tevent_req *req = tevent_req_callback_data(
 430                 subreq, struct tevent_req);
 431         struct cli_echo_state *state = tevent_req_data(
 432                 req, struct cli_echo_state);
 433         NTSTATUS status;
 434         uint32_t num_bytes;
 435         uint8_t *bytes;
 436         uint8_t *inbuf;
 437
 438         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 439                               &num_bytes, &bytes);
 440         if (!NT_STATUS_IS_OK(status)) {
 441                 tevent_req_nterror(req, status);
 442                 return;
 443         }
 444         if ((num_bytes != state->data.length)
 445             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 446                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 447                 return;
 448         }
 449
 450         state->num_echos -=1;
 451         if (state->num_echos == 0) {
 452                 tevent_req_done(req);
 453                 return;
 454         }
 455
 456         if (!cli_smb_req_set_pending(subreq)) {
 457                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 458                 return;
 459         }
 460 }
 461
 462 /**
 463  * Get the result out from an echo request
 464  * @param[in] req       The async_req from cli_echo_send
 465  * @retval Did the server reply correctly?
 466  */
 467
 468 NTSTATUS cli_echo_recv(struct tevent_req *req)
 469 {
 470         return tevent_req_simple_recv_ntstatus(req);
 471 }
 472
 473 /**
 474  * @brief Send/Receive SMBEcho requests
 475  * @param[in] mem_ctx   The memory context to put the async_req on
 476  * @param[in] ev        The event context that will call us back
 477  * @param[in] cli       The connection to send the echo to
 478  * @param[in] num_echos How many times do we want to get the reply?
 479  * @param[in] data      The data we want to get back
 480  * @retval Did the server reply correctly?
 481  */
 482
 483 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 484 {
 485         TALLOC_CTX *frame = talloc_stackframe();
 486         struct event_context *ev;
 487         struct tevent_req *req;
 488         NTSTATUS status = NT_STATUS_OK;
 489
 490         if (cli_has_async_calls(cli)) {
 491                 /*
 492                  * Can't use sync call while an async call is in flight
 493                  */
 494                 status = NT_STATUS_INVALID_PARAMETER;
 495                 goto fail;
 496         }
 497
 498         ev = event_context_init(frame);
 499         if (ev == NULL) {
 500                 status = NT_STATUS_NO_MEMORY;
 501                 goto fail;
 502         }
 503
 504         req = cli_echo_send(frame, ev, cli, num_echos, data);
 505         if (req == NULL) {
 506                 status = NT_STATUS_NO_MEMORY;
 507                 goto fail;
 508         }
 509
 510         if (!tevent_req_poll(req, ev)) {
 511                 status = map_nt_error_from_unix(errno);
 512                 goto fail;
 513         }
 514
 515         status = cli_echo_recv(req);
 516  fail:
 517         TALLOC_FREE(frame);
 518         if (!NT_STATUS_IS_OK(status)) {
 519                 cli_set_error(cli, status);
 520         }
 521         return status;
 522 }
 523
 524 /**
 525  * Is the SMB command able to hold an AND_X successor
 526  * @param[in] cmd       The SMB command in question
 527  * @retval Can we add a chained request after "cmd"?
 528  */
 529 bool is_andx_req(uint8_t cmd)
 530 {
 531         switch (cmd) {
 532         case SMBtconX:
 533         case SMBlockingX:
 534         case SMBopenX:
 535         case SMBreadX:
 536         case SMBwriteX:
 537         case SMBsesssetupX:
 538         case SMBulogoffX:
 539         case SMBntcreateX:
 540                 return true;
 541                 break;
 542         default:
 543                 break;
 544         }
 545
 546         return false;
 547 }
 548
 549 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 550                  uint8_t smb_command, uint8_t additional_flags,
 551                  uint8_t wct, uint16_t *vwv,
 552                  uint32_t num_bytes, const uint8_t *bytes,
 553                  struct tevent_req **result_parent,
 554                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 555                  uint32_t *pnum_bytes, uint8_t **pbytes)
 556 {
 557         struct tevent_context *ev;
 558         struct tevent_req *req = NULL;
 559         NTSTATUS status = NT_STATUS_NO_MEMORY;
 560
 561         if (cli_has_async_calls(cli)) {
 562                 return NT_STATUS_INVALID_PARAMETER;
 563         }
 564         ev = tevent_context_init(mem_ctx);
 565         if (ev == NULL) {
 566                 goto fail;
 567         }
 568         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 569                            wct, vwv, num_bytes, bytes);
 570         if (req == NULL) {
 571                 goto fail;
 572         }
 573         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 574                 goto fail;
 575         }
 576         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 577                               pnum_bytes, pbytes);
 578 fail:
 579         TALLOC_FREE(ev);
 580         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 581                 *result_parent = req;
 582         }
 583         return status;
 584 }