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->capabilities & 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->pid);
  72         memset(buf+smb_pidhigh, 0, 12);
  73         SSVAL(buf,smb_uid,cli->vuid);
  74         SSVAL(buf,smb_mid,cli->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->capabilities & CAP_UNICODE)
  88                 flags2 |= FLAGS2_UNICODE_STRINGS;
  89         if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
  90                 flags2 |= FLAGS2_DFS_PATHNAMES;
  91         if (cli->capabilities & 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_initialise_ex(int signing_state)
 165 {
 166         struct cli_state *cli = NULL;
 167         bool allow_smb_signing = false;
 168         bool mandatory_signing = false;
 169
 170         /* Check the effective uid - make sure we are not setuid */
 171         if (is_setuid_root()) {
 172                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
 173                 return NULL;
 174         }
 175
 176         cli = talloc_zero(NULL, struct cli_state);
 177         if (!cli) {
 178                 return NULL;
 179         }
 180
 181         cli->dfs_mountpoint = talloc_strdup(cli, "");
 182         if (!cli->dfs_mountpoint) {
 183                 goto error;
 184         }
 185         cli->fd = -1;
 186         cli->raw_status = NT_STATUS_INTERNAL_ERROR;
 187         cli->cnum = -1;
 188         cli->pid = (uint16)sys_getpid();
 189         cli->mid = 1;
 190         cli->vuid = UID_FIELD_INVALID;
 191         cli->protocol = PROTOCOL_NT1;
 192         cli->timeout = 20000; /* Timeout is in milliseconds. */
 193         cli->max_xmit = CLI_BUFFER_SIZE+4;
 194         cli->oplock_handler = cli_oplock_ack;
 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->outgoing = tevent_queue_create(cli, "cli_outgoing");
 237         if (cli->outgoing == NULL) {
 238                 goto error;
 239         }
 240         cli->pending = NULL;
 241
 242         cli->initialised = 1;
 243
 244         return cli;
 245
 246         /* Clean up after malloc() error */
 247
 248  error:
 249
 250         TALLOC_FREE(cli);
 251         return NULL;
 252 }
 253
 254 struct cli_state *cli_initialise(void)
 255 {
 256         return cli_initialise_ex(Undefined);
 257 }
 258
 259 /****************************************************************************
 260  Close all pipes open on this session.
 261 ****************************************************************************/
 262
 263 void cli_nt_pipes_close(struct cli_state *cli)
 264 {
 265         while (cli->pipe_list != NULL) {
 266                 /*
 267                  * No TALLOC_FREE here!
 268                  */
 269                 talloc_free(cli->pipe_list);
 270         }
 271 }
 272
 273 /****************************************************************************
 274  Shutdown a client structure.
 275 ****************************************************************************/
 276
 277 static void _cli_shutdown(struct cli_state *cli)
 278 {
 279         cli_nt_pipes_close(cli);
 280
 281         /*
 282          * tell our peer to free his resources.  Wihtout this, when an
 283          * application attempts to do a graceful shutdown and calls
 284          * smbc_free_context() to clean up all connections, some connections
 285          * can remain active on the peer end, until some (long) timeout period
 286          * later.  This tree disconnect forces the peer to clean up, since the
 287          * connection will be going away.
 288          */
 289         if (cli->cnum != (uint16)-1) {
 290                 cli_tdis(cli);
 291         }
 292
 293         data_blob_free(&cli->secblob);
 294         data_blob_free(&cli->user_session_key);
 295
 296         if (cli->fd != -1) {
 297                 close(cli->fd);
 298         }
 299         cli->fd = -1;
 300
 301         /*
 302          * Need to free pending first, they remove themselves
 303          */
 304         while (cli->pending) {
 305                 talloc_free(cli->pending[0]);
 306         }
 307         TALLOC_FREE(cli);
 308 }
 309
 310 void cli_shutdown(struct cli_state *cli)
 311 {
 312         struct cli_state *cli_head;
 313         if (cli == NULL) {
 314                 return;
 315         }
 316         DLIST_HEAD(cli, cli_head);
 317         if (cli_head == cli) {
 318                 /*
 319                  * head of a DFS list, shutdown all subsidiary DFS
 320                  * connections.
 321                  */
 322                 struct cli_state *p, *next;
 323
 324                 for (p = cli_head->next; p; p = next) {
 325                         next = p->next;
 326                         DLIST_REMOVE(cli_head, p);
 327                         _cli_shutdown(p);
 328                 }
 329         } else {
 330                 DLIST_REMOVE(cli_head, cli);
 331         }
 332
 333         _cli_shutdown(cli);
 334 }
 335
 336 /****************************************************************************
 337  Set socket options on a open connection.
 338 ****************************************************************************/
 339
 340 void cli_sockopt(struct cli_state *cli, const char *options)
 341 {
 342         set_socket_options(cli->fd, options);
 343 }
 344
 345 /****************************************************************************
 346  Set the PID to use for smb messages. Return the old pid.
 347 ****************************************************************************/
 348
 349 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 350 {
 351         uint16 ret = cli->pid;
 352         cli->pid = pid;
 353         return ret;
 354 }
 355
 356 /****************************************************************************
 357  Set the case sensitivity flag on the packets. Returns old state.
 358 ****************************************************************************/
 359
 360 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 361 {
 362         bool ret = cli->case_sensitive;
 363         cli->case_sensitive = case_sensitive;
 364         return ret;
 365 }
 366
 367 struct cli_echo_state {
 368         uint16_t vwv[1];
 369         DATA_BLOB data;
 370         int num_echos;
 371 };
 372
 373 static void cli_echo_done(struct tevent_req *subreq);
 374
 375 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 376                                  struct cli_state *cli, uint16_t num_echos,
 377                                  DATA_BLOB data)
 378 {
 379         struct tevent_req *req, *subreq;
 380         struct cli_echo_state *state;
 381
 382         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 383         if (req == NULL) {
 384                 return NULL;
 385         }
 386         SSVAL(state->vwv, 0, num_echos);
 387         state->data = data;
 388         state->num_echos = num_echos;
 389
 390         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 391                               data.length, data.data);
 392         if (subreq == NULL) {
 393                 goto fail;
 394         }
 395         tevent_req_set_callback(subreq, cli_echo_done, req);
 396         return req;
 397  fail:
 398         TALLOC_FREE(req);
 399         return NULL;
 400 }
 401
 402 static void cli_echo_done(struct tevent_req *subreq)
 403 {
 404         struct tevent_req *req = tevent_req_callback_data(
 405                 subreq, struct tevent_req);
 406         struct cli_echo_state *state = tevent_req_data(
 407                 req, struct cli_echo_state);
 408         NTSTATUS status;
 409         uint32_t num_bytes;
 410         uint8_t *bytes;
 411         uint8_t *inbuf;
 412
 413         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 414                               &num_bytes, &bytes);
 415         if (!NT_STATUS_IS_OK(status)) {
 416                 tevent_req_nterror(req, status);
 417                 return;
 418         }
 419         if ((num_bytes != state->data.length)
 420             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 421                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 422                 return;
 423         }
 424
 425         state->num_echos -=1;
 426         if (state->num_echos == 0) {
 427                 tevent_req_done(req);
 428                 return;
 429         }
 430
 431         if (!cli_smb_req_set_pending(subreq)) {
 432                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 433                 return;
 434         }
 435 }
 436
 437 /**
 438  * Get the result out from an echo request
 439  * @param[in] req       The async_req from cli_echo_send
 440  * @retval Did the server reply correctly?
 441  */
 442
 443 NTSTATUS cli_echo_recv(struct tevent_req *req)
 444 {
 445         return tevent_req_simple_recv_ntstatus(req);
 446 }
 447
 448 /**
 449  * @brief Send/Receive SMBEcho requests
 450  * @param[in] mem_ctx   The memory context to put the async_req on
 451  * @param[in] ev        The event context that will call us back
 452  * @param[in] cli       The connection to send the echo to
 453  * @param[in] num_echos How many times do we want to get the reply?
 454  * @param[in] data      The data we want to get back
 455  * @retval Did the server reply correctly?
 456  */
 457
 458 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 459 {
 460         TALLOC_CTX *frame = talloc_stackframe();
 461         struct event_context *ev;
 462         struct tevent_req *req;
 463         NTSTATUS status = NT_STATUS_OK;
 464
 465         if (cli_has_async_calls(cli)) {
 466                 /*
 467                  * Can't use sync call while an async call is in flight
 468                  */
 469                 status = NT_STATUS_INVALID_PARAMETER;
 470                 goto fail;
 471         }
 472
 473         ev = event_context_init(frame);
 474         if (ev == NULL) {
 475                 status = NT_STATUS_NO_MEMORY;
 476                 goto fail;
 477         }
 478
 479         req = cli_echo_send(frame, ev, cli, num_echos, data);
 480         if (req == NULL) {
 481                 status = NT_STATUS_NO_MEMORY;
 482                 goto fail;
 483         }
 484
 485         if (!tevent_req_poll(req, ev)) {
 486                 status = map_nt_error_from_unix(errno);
 487                 goto fail;
 488         }
 489
 490         status = cli_echo_recv(req);
 491  fail:
 492         TALLOC_FREE(frame);
 493         return status;
 494 }
 495
 496 /**
 497  * Is the SMB command able to hold an AND_X successor
 498  * @param[in] cmd       The SMB command in question
 499  * @retval Can we add a chained request after "cmd"?
 500  */
 501 bool is_andx_req(uint8_t cmd)
 502 {
 503         switch (cmd) {
 504         case SMBtconX:
 505         case SMBlockingX:
 506         case SMBopenX:
 507         case SMBreadX:
 508         case SMBwriteX:
 509         case SMBsesssetupX:
 510         case SMBulogoffX:
 511         case SMBntcreateX:
 512                 return true;
 513                 break;
 514         default:
 515                 break;
 516         }
 517
 518         return false;
 519 }
 520
 521 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 522                  uint8_t smb_command, uint8_t additional_flags,
 523                  uint8_t wct, uint16_t *vwv,
 524                  uint32_t num_bytes, const uint8_t *bytes,
 525                  struct tevent_req **result_parent,
 526                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 527                  uint32_t *pnum_bytes, uint8_t **pbytes)
 528 {
 529         struct tevent_context *ev;
 530         struct tevent_req *req = NULL;
 531         NTSTATUS status = NT_STATUS_NO_MEMORY;
 532
 533         if (cli_has_async_calls(cli)) {
 534                 return NT_STATUS_INVALID_PARAMETER;
 535         }
 536         ev = tevent_context_init(mem_ctx);
 537         if (ev == NULL) {
 538                 goto fail;
 539         }
 540         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 541                            wct, vwv, num_bytes, bytes);
 542         if (req == NULL) {
 543                 goto fail;
 544         }
 545         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 546                 goto fail;
 547         }
 548         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 549                               pnum_bytes, pbytes);
 550 fail:
 551         TALLOC_FREE(ev);
 552         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 553                 *result_parent = req;
 554         }
 555         return status;
 556 }