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