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->smb1.pid);
  72         memset(buf+smb_pidhigh, 0, 12);
  73         SSVAL(buf,smb_uid,cli->vuid);
  74         SSVAL(buf,smb_mid,cli->smb1.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->vuid = UID_FIELD_INVALID;
 188         cli->protocol = PROTOCOL_NT1;
 189         cli->timeout = 20000; /* Timeout is in milliseconds. */
 190         cli->max_xmit = CLI_BUFFER_SIZE+4;
 191         cli->case_sensitive = false;
 192
 193         cli->use_spnego = lp_client_use_spnego();
 194
 195         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
 196
 197         /* Set the CLI_FORCE_DOSERR environment variable to test
 198            client routines using DOS errors instead of STATUS32
 199            ones.  This intended only as a temporary hack. */
 200         if (getenv("CLI_FORCE_DOSERR"))
 201                 cli->force_dos_errors = true;
 202
 203         if (lp_client_signing()) {
 204                 allow_smb_signing = true;
 205         }
 206
 207         if (lp_client_signing() == Required) {
 208                 mandatory_signing = true;
 209         }
 210
 211         if (signing_state != Undefined) {
 212                 allow_smb_signing = true;
 213         }
 214
 215         if (signing_state == false) {
 216                 allow_smb_signing = false;
 217                 mandatory_signing = false;
 218         }
 219
 220         if (signing_state == Required) {
 221                 mandatory_signing = true;
 222         }
 223
 224         /* initialise signing */
 225         cli->signing_state = smb_signing_init(cli,
 226                                               allow_smb_signing,
 227                                               mandatory_signing);
 228         if (!cli->signing_state) {
 229                 goto error;
 230         }
 231
 232         cli->outgoing = tevent_queue_create(cli, "cli_outgoing");
 233         if (cli->outgoing == NULL) {
 234                 goto error;
 235         }
 236         cli->pending = NULL;
 237
 238         cli->initialised = 1;
 239
 240         cli->smb1.mid = 1;
 241         cli->smb1.pid = (uint16_t)sys_getpid();
 242         cli->smb1.vc_num = cli->smb1.pid;
 243         cli->smb1.tid = UINT16_MAX;
 244
 245         return cli;
 246
 247         /* Clean up after malloc() error */
 248
 249  error:
 250
 251         TALLOC_FREE(cli);
 252         return NULL;
 253 }
 254
 255 struct cli_state *cli_initialise(void)
 256 {
 257         return cli_initialise_ex(Undefined);
 258 }
 259
 260 /****************************************************************************
 261  Close all pipes open on this session.
 262 ****************************************************************************/
 263
 264 void cli_nt_pipes_close(struct cli_state *cli)
 265 {
 266         while (cli->pipe_list != NULL) {
 267                 /*
 268                  * No TALLOC_FREE here!
 269                  */
 270                 talloc_free(cli->pipe_list);
 271         }
 272 }
 273
 274 /****************************************************************************
 275  Shutdown a client structure.
 276 ****************************************************************************/
 277
 278 static void _cli_shutdown(struct cli_state *cli)
 279 {
 280         cli_nt_pipes_close(cli);
 281
 282         /*
 283          * tell our peer to free his resources.  Wihtout this, when an
 284          * application attempts to do a graceful shutdown and calls
 285          * smbc_free_context() to clean up all connections, some connections
 286          * can remain active on the peer end, until some (long) timeout period
 287          * later.  This tree disconnect forces the peer to clean up, since the
 288          * connection will be going away.
 289          */
 290         if (cli_state_has_tcon(cli)) {
 291                 cli_tdis(cli);
 292         }
 293
 294         data_blob_free(&cli->secblob);
 295         data_blob_free(&cli->user_session_key);
 296
 297         if (cli->fd != -1) {
 298                 close(cli->fd);
 299         }
 300         cli->fd = -1;
 301
 302         /*
 303          * Need to free pending first, they remove themselves
 304          */
 305         while (cli->pending) {
 306                 talloc_free(cli->pending[0]);
 307         }
 308         TALLOC_FREE(cli);
 309 }
 310
 311 void cli_shutdown(struct cli_state *cli)
 312 {
 313         struct cli_state *cli_head;
 314         if (cli == NULL) {
 315                 return;
 316         }
 317         DLIST_HEAD(cli, cli_head);
 318         if (cli_head == cli) {
 319                 /*
 320                  * head of a DFS list, shutdown all subsidiary DFS
 321                  * connections.
 322                  */
 323                 struct cli_state *p, *next;
 324
 325                 for (p = cli_head->next; p; p = next) {
 326                         next = p->next;
 327                         DLIST_REMOVE(cli_head, p);
 328                         _cli_shutdown(p);
 329                 }
 330         } else {
 331                 DLIST_REMOVE(cli_head, cli);
 332         }
 333
 334         _cli_shutdown(cli);
 335 }
 336
 337 /****************************************************************************
 338  Set socket options on a open connection.
 339 ****************************************************************************/
 340
 341 void cli_sockopt(struct cli_state *cli, const char *options)
 342 {
 343         set_socket_options(cli->fd, options);
 344 }
 345
 346 uint16_t cli_state_get_vc_num(struct cli_state *cli)
 347 {
 348         return cli->smb1.vc_num;
 349 }
 350
 351 /****************************************************************************
 352  Set the PID to use for smb messages. Return the old pid.
 353 ****************************************************************************/
 354
 355 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
 356 {
 357         uint16_t ret = cli->smb1.pid;
 358         cli->smb1.pid = pid;
 359         return ret;
 360 }
 361
 362 uint16_t cli_getpid(struct cli_state *cli)
 363 {
 364         return cli->smb1.pid;
 365 }
 366
 367 bool cli_state_has_tcon(struct cli_state *cli)
 368 {
 369         if (cli->smb1.tid == UINT16_MAX) {
 370                 return false;
 371         }
 372
 373         return true;
 374 }
 375
 376 uint16_t cli_state_get_tid(struct cli_state *cli)
 377 {
 378         return cli->smb1.tid;
 379 }
 380
 381 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
 382 {
 383         uint16_t ret = cli->smb1.tid;
 384         cli->smb1.tid = tid;
 385         return ret;
 386 }
 387
 388 /****************************************************************************
 389  Set the case sensitivity flag on the packets. Returns old state.
 390 ****************************************************************************/
 391
 392 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 393 {
 394         bool ret = cli->case_sensitive;
 395         cli->case_sensitive = case_sensitive;
 396         return ret;
 397 }
 398
 399 struct cli_echo_state {
 400         uint16_t vwv[1];
 401         DATA_BLOB data;
 402         int num_echos;
 403 };
 404
 405 static void cli_echo_done(struct tevent_req *subreq);
 406
 407 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
 408                                  struct cli_state *cli, uint16_t num_echos,
 409                                  DATA_BLOB data)
 410 {
 411         struct tevent_req *req, *subreq;
 412         struct cli_echo_state *state;
 413
 414         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 415         if (req == NULL) {
 416                 return NULL;
 417         }
 418         SSVAL(state->vwv, 0, num_echos);
 419         state->data = data;
 420         state->num_echos = num_echos;
 421
 422         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
 423                               data.length, data.data);
 424         if (subreq == NULL) {
 425                 goto fail;
 426         }
 427         tevent_req_set_callback(subreq, cli_echo_done, req);
 428         return req;
 429  fail:
 430         TALLOC_FREE(req);
 431         return NULL;
 432 }
 433
 434 static void cli_echo_done(struct tevent_req *subreq)
 435 {
 436         struct tevent_req *req = tevent_req_callback_data(
 437                 subreq, struct tevent_req);
 438         struct cli_echo_state *state = tevent_req_data(
 439                 req, struct cli_echo_state);
 440         NTSTATUS status;
 441         uint32_t num_bytes;
 442         uint8_t *bytes;
 443         uint8_t *inbuf;
 444
 445         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
 446                               &num_bytes, &bytes);
 447         if (!NT_STATUS_IS_OK(status)) {
 448                 tevent_req_nterror(req, status);
 449                 return;
 450         }
 451         if ((num_bytes != state->data.length)
 452             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
 453                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
 454                 return;
 455         }
 456
 457         state->num_echos -=1;
 458         if (state->num_echos == 0) {
 459                 tevent_req_done(req);
 460                 return;
 461         }
 462
 463         if (!cli_smb_req_set_pending(subreq)) {
 464                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
 465                 return;
 466         }
 467 }
 468
 469 /**
 470  * Get the result out from an echo request
 471  * @param[in] req       The async_req from cli_echo_send
 472  * @retval Did the server reply correctly?
 473  */
 474
 475 NTSTATUS cli_echo_recv(struct tevent_req *req)
 476 {
 477         return tevent_req_simple_recv_ntstatus(req);
 478 }
 479
 480 /**
 481  * @brief Send/Receive SMBEcho requests
 482  * @param[in] mem_ctx   The memory context to put the async_req on
 483  * @param[in] ev        The event context that will call us back
 484  * @param[in] cli       The connection to send the echo to
 485  * @param[in] num_echos How many times do we want to get the reply?
 486  * @param[in] data      The data we want to get back
 487  * @retval Did the server reply correctly?
 488  */
 489
 490 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 491 {
 492         TALLOC_CTX *frame = talloc_stackframe();
 493         struct event_context *ev;
 494         struct tevent_req *req;
 495         NTSTATUS status = NT_STATUS_OK;
 496
 497         if (cli_has_async_calls(cli)) {
 498                 /*
 499                  * Can't use sync call while an async call is in flight
 500                  */
 501                 status = NT_STATUS_INVALID_PARAMETER;
 502                 goto fail;
 503         }
 504
 505         ev = event_context_init(frame);
 506         if (ev == NULL) {
 507                 status = NT_STATUS_NO_MEMORY;
 508                 goto fail;
 509         }
 510
 511         req = cli_echo_send(frame, ev, cli, num_echos, data);
 512         if (req == NULL) {
 513                 status = NT_STATUS_NO_MEMORY;
 514                 goto fail;
 515         }
 516
 517         if (!tevent_req_poll(req, ev)) {
 518                 status = map_nt_error_from_unix(errno);
 519                 goto fail;
 520         }
 521
 522         status = cli_echo_recv(req);
 523  fail:
 524         TALLOC_FREE(frame);
 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 }