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 "../libcli/smb/smb_signing.h"
  25 #include "../libcli/smb/smb_seal.h"
  26 #include "async_smb.h"
  27 #include "../libcli/smb/smbXcli_base.h"
  28 #include "../librpc/ndr/libndr.h"
  29 #include "../include/client.h"
  30
  31 /*******************************************************************
  32  Setup the word count and byte count for a client smb message.
  33 ********************************************************************/
  34
  35 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
  36 {
  37         if (zero && (num_words || num_bytes)) {
  38                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
  39         }
  40         SCVAL(buf,smb_wct,num_words);
  41         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
  42         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
  43         return (smb_size + num_words*2 + num_bytes);
  44 }
  45
  46 /****************************************************************************
  47  Change the timeout (in milliseconds).
  48 ****************************************************************************/
  49
  50 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
  51 {
  52         unsigned int old_timeout = cli->timeout;
  53         cli->timeout = timeout;
  54         return old_timeout;
  55 }
  56
  57 /****************************************************************************
  58  Set the 'backup_intent' flag.
  59 ****************************************************************************/
  60
  61 bool cli_set_backup_intent(struct cli_state *cli, bool flag)
  62 {
  63         bool old_state = cli->backup_intent;
  64         cli->backup_intent = flag;
  65         return old_state;
  66 }
  67
  68 /****************************************************************************
  69  Initialise a client structure. Always returns a talloc'ed struct.
  70  Set the signing state (used from the command line).
  71 ****************************************************************************/
  72
  73 struct GUID cli_state_client_guid;
  74
  75 struct cli_state *cli_state_create(TALLOC_CTX *mem_ctx,
  76                                    int fd,
  77                                    const char *remote_name,
  78                                    const char *remote_realm,
  79                                    int signing_state, int flags)
  80 {
  81         struct cli_state *cli = NULL;
  82         bool use_spnego = lp_client_use_spnego();
  83         bool force_dos_errors = false;
  84         bool force_ascii = false;
  85         bool use_level_II_oplocks = false;
  86         uint32_t smb1_capabilities = 0;
  87         uint32_t smb2_capabilities = 0;
  88         struct GUID client_guid;
  89
  90         if (!GUID_all_zero(&cli_state_client_guid)) {
  91                 client_guid = cli_state_client_guid;
  92         } else {
  93                 client_guid = GUID_random();
  94         }
  95
  96         /* Check the effective uid - make sure we are not setuid */
  97         if (is_setuid_root()) {
  98                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
  99                 return NULL;
 100         }
 101
 102         cli = talloc_zero(mem_ctx, struct cli_state);
 103         if (!cli) {
 104                 return NULL;
 105         }
 106
 107         cli->server_domain = talloc_strdup(cli, "");
 108         if (!cli->server_domain) {
 109                 goto error;
 110         }
 111         cli->server_os = talloc_strdup(cli, "");
 112         if (!cli->server_os) {
 113                 goto error;
 114         }
 115         cli->server_type = talloc_strdup(cli, "");
 116         if (!cli->server_type) {
 117                 goto error;
 118         }
 119
 120         cli->dfs_mountpoint = talloc_strdup(cli, "");
 121         if (!cli->dfs_mountpoint) {
 122                 goto error;
 123         }
 124         cli->raw_status = NT_STATUS_INTERNAL_ERROR;
 125         cli->map_dos_errors = true; /* remove this */
 126         cli->timeout = CLIENT_TIMEOUT;
 127
 128         /* Set the CLI_FORCE_DOSERR environment variable to test
 129            client routines using DOS errors instead of STATUS32
 130            ones.  This intended only as a temporary hack. */
 131         if (getenv("CLI_FORCE_DOSERR")) {
 132                 force_dos_errors = true;
 133         }
 134         if (flags & CLI_FULL_CONNECTION_FORCE_DOS_ERRORS) {
 135                 force_dos_errors = true;
 136         }
 137
 138         if (getenv("CLI_FORCE_ASCII")) {
 139                 force_ascii = true;
 140         }
 141         if (!lp_unicode()) {
 142                 force_ascii = true;
 143         }
 144         if (flags & CLI_FULL_CONNECTION_FORCE_ASCII) {
 145                 force_ascii = true;
 146         }
 147
 148         if (flags & CLI_FULL_CONNECTION_DONT_SPNEGO) {
 149                 use_spnego = false;
 150         } else if (flags & CLI_FULL_CONNECTION_USE_KERBEROS) {
 151                 cli->use_kerberos = true;
 152         }
 153         if ((flags & CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS) &&
 154              cli->use_kerberos) {
 155                 cli->fallback_after_kerberos = true;
 156         }
 157
 158         if (flags & CLI_FULL_CONNECTION_USE_CCACHE) {
 159                 cli->use_ccache = true;
 160         }
 161
 162         if (flags & CLI_FULL_CONNECTION_USE_NT_HASH) {
 163                 cli->pw_nt_hash = true;
 164         }
 165
 166         if (flags & CLI_FULL_CONNECTION_OPLOCKS) {
 167                 cli->use_oplocks = true;
 168         }
 169         if (flags & CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS) {
 170                 use_level_II_oplocks = true;
 171         }
 172
 173         if (signing_state == SMB_SIGNING_DEFAULT) {
 174                 signing_state = lp_client_signing();
 175         }
 176
 177         smb1_capabilities = 0;
 178         smb1_capabilities |= CAP_LARGE_FILES;
 179         smb1_capabilities |= CAP_NT_SMBS | CAP_RPC_REMOTE_APIS;
 180         smb1_capabilities |= CAP_LOCK_AND_READ | CAP_NT_FIND;
 181         smb1_capabilities |= CAP_DFS | CAP_W2K_SMBS;
 182         smb1_capabilities |= CAP_LARGE_READX|CAP_LARGE_WRITEX;
 183         smb1_capabilities |= CAP_LWIO;
 184
 185         if (!force_dos_errors) {
 186                 smb1_capabilities |= CAP_STATUS32;
 187         }
 188
 189         if (!force_ascii) {
 190                 smb1_capabilities |= CAP_UNICODE;
 191         }
 192
 193         if (use_spnego) {
 194                 smb1_capabilities |= CAP_EXTENDED_SECURITY;
 195         }
 196
 197         if (use_level_II_oplocks) {
 198                 smb1_capabilities |= CAP_LEVEL_II_OPLOCKS;
 199         }
 200
 201         smb2_capabilities = SMB2_CAP_ALL;
 202
 203         if (remote_realm) {
 204                 cli->remote_realm = talloc_strdup(cli, remote_realm);
 205                 if (cli->remote_realm == NULL) {
 206                         goto error;
 207                 }
 208         }
 209
 210         cli->conn = smbXcli_conn_create(cli, fd, remote_name,
 211                                         signing_state,
 212                                         smb1_capabilities,
 213                                         &client_guid,
 214                                         smb2_capabilities);
 215         if (cli->conn == NULL) {
 216                 goto error;
 217         }
 218
 219         cli->smb1.pid = (uint16_t)getpid();
 220         cli->smb1.vc_num = cli->smb1.pid;
 221         cli->smb1.tcon = smbXcli_tcon_create(cli);
 222         if (cli->smb1.tcon == NULL) {
 223                 goto error;
 224         }
 225         smb1cli_tcon_set_id(cli->smb1.tcon, UINT16_MAX);
 226         cli->smb1.session = smbXcli_session_create(cli, cli->conn);
 227         if (cli->smb1.session == NULL) {
 228                 goto error;
 229         }
 230
 231         cli->initialised = 1;
 232         return cli;
 233
 234         /* Clean up after malloc() error */
 235
 236  error:
 237
 238         TALLOC_FREE(cli);
 239         return NULL;
 240 }
 241
 242 /****************************************************************************
 243  Close all pipes open on this session.
 244 ****************************************************************************/
 245
 246 void cli_nt_pipes_close(struct cli_state *cli)
 247 {
 248         while (cli->pipe_list != NULL) {
 249                 /*
 250                  * No TALLOC_FREE here!
 251                  */
 252                 talloc_free(cli->pipe_list);
 253         }
 254 }
 255
 256 /****************************************************************************
 257  Shutdown a client structure.
 258 ****************************************************************************/
 259
 260 static void _cli_shutdown(struct cli_state *cli)
 261 {
 262         cli_nt_pipes_close(cli);
 263
 264         /*
 265          * tell our peer to free his resources.  Wihtout this, when an
 266          * application attempts to do a graceful shutdown and calls
 267          * smbc_free_context() to clean up all connections, some connections
 268          * can remain active on the peer end, until some (long) timeout period
 269          * later.  This tree disconnect forces the peer to clean up, since the
 270          * connection will be going away.
 271          */
 272         if (cli_state_has_tcon(cli)) {
 273                 cli_tdis(cli);
 274         }
 275
 276         smbXcli_conn_disconnect(cli->conn, NT_STATUS_OK);
 277
 278         TALLOC_FREE(cli);
 279 }
 280
 281 void cli_shutdown(struct cli_state *cli)
 282 {
 283         struct cli_state *cli_head;
 284         if (cli == NULL) {
 285                 return;
 286         }
 287         DLIST_HEAD(cli, cli_head);
 288         if (cli_head == cli) {
 289                 /*
 290                  * head of a DFS list, shutdown all subsidiary DFS
 291                  * connections.
 292                  */
 293                 struct cli_state *p, *next;
 294
 295                 for (p = cli_head->next; p; p = next) {
 296                         next = p->next;
 297                         DLIST_REMOVE(cli_head, p);
 298                         _cli_shutdown(p);
 299                 }
 300         } else {
 301                 DLIST_REMOVE(cli_head, cli);
 302         }
 303
 304         _cli_shutdown(cli);
 305 }
 306
 307 const char *cli_state_remote_realm(struct cli_state *cli)
 308 {
 309         return cli->remote_realm;
 310 }
 311
 312 uint16_t cli_state_get_vc_num(struct cli_state *cli)
 313 {
 314         return cli->smb1.vc_num;
 315 }
 316
 317 /****************************************************************************
 318  Set the PID to use for smb messages. Return the old pid.
 319 ****************************************************************************/
 320
 321 uint16_t cli_setpid(struct cli_state *cli, uint16_t pid)
 322 {
 323         uint16_t ret = cli->smb1.pid;
 324         cli->smb1.pid = pid;
 325         return ret;
 326 }
 327
 328 uint16_t cli_getpid(struct cli_state *cli)
 329 {
 330         return cli->smb1.pid;
 331 }
 332
 333 bool cli_state_has_tcon(struct cli_state *cli)
 334 {
 335         uint16_t tid = cli_state_get_tid(cli);
 336
 337         if (tid == UINT16_MAX) {
 338                 return false;
 339         }
 340
 341         return true;
 342 }
 343
 344 uint16_t cli_state_get_tid(struct cli_state *cli)
 345 {
 346         return smb1cli_tcon_current_id(cli->smb1.tcon);
 347 }
 348
 349 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
 350 {
 351         uint16_t ret = smb1cli_tcon_current_id(cli->smb1.tcon);
 352         smb1cli_tcon_set_id(cli->smb1.tcon, tid);
 353         return ret;
 354 }
 355
 356 uint16_t cli_state_get_uid(struct cli_state *cli)
 357 {
 358         return smb1cli_session_current_id(cli->smb1.session);
 359 }
 360
 361 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
 362 {
 363         uint16_t ret = smb1cli_session_current_id(cli->smb1.session);
 364         smb1cli_session_set_id(cli->smb1.session, uid);
 365         return ret;
 366 }
 367
 368 /****************************************************************************
 369  Set the case sensitivity flag on the packets. Returns old state.
 370 ****************************************************************************/
 371
 372 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
 373 {
 374         bool ret;
 375         uint32_t fs_attrs;
 376         struct smbXcli_tcon *tcon;
 377
 378         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 379                 tcon = cli->smb2.tcon;
 380         } else {
 381                 tcon = cli->smb1.tcon;
 382         }
 383
 384         fs_attrs = smbXcli_tcon_get_fs_attributes(tcon);
 385         if (fs_attrs & FILE_CASE_SENSITIVE_SEARCH) {
 386                 ret = true;
 387         } else {
 388                 ret = false;
 389         }
 390         if (case_sensitive) {
 391                 fs_attrs |= FILE_CASE_SENSITIVE_SEARCH;
 392         } else {
 393                 fs_attrs &= ~FILE_CASE_SENSITIVE_SEARCH;
 394         }
 395         smbXcli_tcon_set_fs_attributes(tcon, fs_attrs);
 396
 397         return ret;
 398 }
 399
 400 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
 401 {
 402         uint32_t ret = smb1cli_conn_max_xmit(cli->conn);
 403
 404         if (ofs >= ret) {
 405                 return 0;
 406         }
 407
 408         ret -= ofs;
 409
 410         return ret;
 411 }
 412
 413 time_t cli_state_server_time(struct cli_state *cli)
 414 {
 415         NTTIME nt;
 416         time_t t;
 417
 418         nt = smbXcli_conn_server_system_time(cli->conn);
 419         t = nt_time_to_unix(nt);
 420
 421         return t;
 422 }
 423
 424 struct cli_echo_state {
 425         bool is_smb2;
 426 };
 427
 428 static void cli_echo_done(struct tevent_req *subreq);
 429
 430 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
 431                                  struct cli_state *cli, uint16_t num_echos,
 432                                  DATA_BLOB data)
 433 {
 434         struct tevent_req *req, *subreq;
 435         struct cli_echo_state *state;
 436
 437         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
 438         if (req == NULL) {
 439                 return NULL;
 440         }
 441
 442         if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
 443                 state->is_smb2 = true;
 444                 subreq = smb2cli_echo_send(state, ev,
 445                                            cli->conn,
 446                                            cli->timeout);
 447         } else {
 448                 subreq = smb1cli_echo_send(state, ev,
 449                                            cli->conn,
 450                                            cli->timeout,
 451                                            num_echos,
 452                                            data);
 453         }
 454         if (tevent_req_nomem(subreq, req)) {
 455                 return tevent_req_post(req, ev);
 456         }
 457         tevent_req_set_callback(subreq, cli_echo_done, req);
 458
 459         return req;
 460 }
 461
 462 static void cli_echo_done(struct tevent_req *subreq)
 463 {
 464         struct tevent_req *req = tevent_req_callback_data(
 465                 subreq, struct tevent_req);
 466         struct cli_echo_state *state = tevent_req_data(
 467                 req, struct cli_echo_state);
 468         NTSTATUS status;
 469
 470         if (state->is_smb2) {
 471                 status = smb2cli_echo_recv(subreq);
 472         } else {
 473                 status = smb1cli_echo_recv(subreq);
 474         }
 475         TALLOC_FREE(subreq);
 476         if (!NT_STATUS_IS_OK(status)) {
 477                 tevent_req_nterror(req, status);
 478                 return;
 479         }
 480
 481         tevent_req_done(req);
 482 }
 483
 484 /**
 485  * Get the result out from an echo request
 486  * @param[in] req       The async_req from cli_echo_send
 487  * @retval Did the server reply correctly?
 488  */
 489
 490 NTSTATUS cli_echo_recv(struct tevent_req *req)
 491 {
 492         return tevent_req_simple_recv_ntstatus(req);
 493 }
 494
 495 /**
 496  * @brief Send/Receive SMBEcho requests
 497  * @param[in] mem_ctx   The memory context to put the async_req on
 498  * @param[in] ev        The event context that will call us back
 499  * @param[in] cli       The connection to send the echo to
 500  * @param[in] num_echos How many times do we want to get the reply?
 501  * @param[in] data      The data we want to get back
 502  * @retval Did the server reply correctly?
 503  */
 504
 505 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
 506 {
 507         TALLOC_CTX *frame = talloc_stackframe();
 508         struct tevent_context *ev;
 509         struct tevent_req *req;
 510         NTSTATUS status = NT_STATUS_OK;
 511
 512         if (smbXcli_conn_has_async_calls(cli->conn)) {
 513                 /*
 514                  * Can't use sync call while an async call is in flight
 515                  */
 516                 status = NT_STATUS_INVALID_PARAMETER;
 517                 goto fail;
 518         }
 519
 520         ev = samba_tevent_context_init(frame);
 521         if (ev == NULL) {
 522                 status = NT_STATUS_NO_MEMORY;
 523                 goto fail;
 524         }
 525
 526         req = cli_echo_send(frame, ev, cli, num_echos, data);
 527         if (req == NULL) {
 528                 status = NT_STATUS_NO_MEMORY;
 529                 goto fail;
 530         }
 531
 532         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 533                 goto fail;
 534         }
 535
 536         status = cli_echo_recv(req);
 537  fail:
 538         TALLOC_FREE(frame);
 539         return status;
 540 }
 541
 542 /**
 543  * Is the SMB command able to hold an AND_X successor
 544  * @param[in] cmd       The SMB command in question
 545  * @retval Can we add a chained request after "cmd"?
 546  */
 547 bool is_andx_req(uint8_t cmd)
 548 {
 549         switch (cmd) {
 550         case SMBtconX:
 551         case SMBlockingX:
 552         case SMBopenX:
 553         case SMBreadX:
 554         case SMBwriteX:
 555         case SMBsesssetupX:
 556         case SMBulogoffX:
 557         case SMBntcreateX:
 558                 return true;
 559                 break;
 560         default:
 561                 break;
 562         }
 563
 564         return false;
 565 }
 566
 567 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
 568                  uint8_t smb_command, uint8_t additional_flags,
 569                  uint8_t wct, uint16_t *vwv,
 570                  uint32_t num_bytes, const uint8_t *bytes,
 571                  struct tevent_req **result_parent,
 572                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
 573                  uint32_t *pnum_bytes, uint8_t **pbytes)
 574 {
 575         struct tevent_context *ev;
 576         struct tevent_req *req = NULL;
 577         NTSTATUS status = NT_STATUS_NO_MEMORY;
 578
 579         if (smbXcli_conn_has_async_calls(cli->conn)) {
 580                 return NT_STATUS_INVALID_PARAMETER;
 581         }
 582         ev = samba_tevent_context_init(mem_ctx);
 583         if (ev == NULL) {
 584                 goto fail;
 585         }
 586         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
 587                            wct, vwv, num_bytes, bytes);
 588         if (req == NULL) {
 589                 goto fail;
 590         }
 591         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
 592                 goto fail;
 593         }
 594         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
 595                               pnum_bytes, pbytes);
 596 fail:
 597         TALLOC_FREE(ev);
 598         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
 599                 *result_parent = req;
 600         }
 601         return status;
 602 }