source4/libcli/raw/clitransport.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB client transport context management functions
   4
   5    Copyright (C) Andrew Tridgell 1994-2005
   6    Copyright (C) James Myers 2003 <myersjj@samba.org>
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "system/network.h"
  24 #include "../lib/async_req/async_sock.h"
  25 #include "../lib/util/tevent_ntstatus.h"
  26 #include "libcli/raw/libcliraw.h"
  27 #include "libcli/raw/raw_proto.h"
  28 #include "lib/socket/socket.h"
  29 #include "lib/events/events.h"
  30 #include "librpc/gen_ndr/ndr_nbt.h"
  31 #include "../libcli/nbt/libnbt.h"
  32 #include "../libcli/smb/smbXcli_base.h"
  33 #include "../libcli/smb/read_smb.h"
  34
  35 /*
  36   destroy a transport
  37  */
  38 static int transport_destructor(struct smbcli_transport *transport)
  39 {
  40         smbcli_transport_dead(transport, NT_STATUS_LOCAL_DISCONNECT);
  41         return 0;
  42 }
  43
  44 /*
  45   create a transport structure based on an established socket
  46 */
  47 struct smbcli_transport *smbcli_transport_init(struct smbcli_socket *sock,
  48                                                TALLOC_CTX *parent_ctx,
  49                                                bool primary,
  50                                                struct smbcli_options *options)
  51 {
  52         struct smbcli_transport *transport;
  53         uint32_t smb1_capabilities;
  54
  55         transport = talloc_zero(parent_ctx, struct smbcli_transport);
  56         if (!transport) return NULL;
  57
  58         transport->ev = sock->event.ctx;
  59         transport->options = *options;
  60
  61         TALLOC_FREE(sock->event.fde);
  62         TALLOC_FREE(sock->event.te);
  63
  64         smb1_capabilities = 0;
  65         smb1_capabilities |= CAP_LARGE_FILES;
  66         smb1_capabilities |= CAP_NT_SMBS | CAP_RPC_REMOTE_APIS;
  67         smb1_capabilities |= CAP_LOCK_AND_READ | CAP_NT_FIND;
  68         smb1_capabilities |= CAP_DFS | CAP_W2K_SMBS;
  69         smb1_capabilities |= CAP_LARGE_READX|CAP_LARGE_WRITEX;
  70         smb1_capabilities |= CAP_LWIO;
  71
  72         if (options->ntstatus_support) {
  73                 smb1_capabilities |= CAP_STATUS32;
  74         }
  75
  76         if (options->unicode) {
  77                 smb1_capabilities |= CAP_UNICODE;
  78         }
  79
  80         if (options->use_spnego) {
  81                 smb1_capabilities |= CAP_EXTENDED_SECURITY;
  82         }
  83
  84         if (options->use_level2_oplocks) {
  85                 smb1_capabilities |= CAP_LEVEL_II_OPLOCKS;
  86         }
  87
  88         transport->conn = smbXcli_conn_create(transport,
  89                                               sock->sock->fd,
  90                                               sock->hostname,
  91                                               options->signing,
  92                                               smb1_capabilities,
  93                                               NULL, /* client_guid */
  94                                               0); /* smb2_capabilities */
  95         if (transport->conn == NULL) {
  96                 TALLOC_FREE(sock);
  97                 TALLOC_FREE(transport);
  98                 return NULL;
  99         }
 100         sock->sock->fd = -1;
 101         TALLOC_FREE(sock);
 102
 103         talloc_set_destructor(transport, transport_destructor);
 104
 105         return transport;
 106 }
 107
 108 /*
 109   mark the transport as dead
 110 */
 111 void smbcli_transport_dead(struct smbcli_transport *transport, NTSTATUS status)
 112 {
 113         if (NT_STATUS_EQUAL(NT_STATUS_UNSUCCESSFUL, status)) {
 114                 status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
 115         }
 116         if (NT_STATUS_IS_OK(status)) {
 117                 status = NT_STATUS_LOCAL_DISCONNECT;
 118         }
 119
 120         smbXcli_conn_disconnect(transport->conn, status);
 121 }
 122
 123 static void idle_handler(struct tevent_context *ev,
 124                          struct tevent_timer *te, struct timeval t, void *private_data)
 125 {
 126         struct smbcli_transport *transport = talloc_get_type(private_data,
 127                                                              struct smbcli_transport);
 128         struct timeval next;
 129
 130         transport->idle.func(transport, transport->idle.private_data);
 131
 132         next = timeval_current_ofs_usec(transport->idle.period);
 133
 134         transport->idle.te = tevent_add_timer(transport->ev,
 135                                               transport,
 136                                               next,
 137                                               idle_handler,
 138                                               transport);
 139 }
 140
 141 /*
 142   setup the idle handler for a transport
 143   the period is in microseconds
 144 */
 145 _PUBLIC_ void smbcli_transport_idle_handler(struct smbcli_transport *transport,
 146                                    void (*idle_func)(struct smbcli_transport *, void *),
 147                                    uint64_t period,
 148                                    void *private_data)
 149 {
 150         TALLOC_FREE(transport->idle.te);
 151
 152         transport->idle.func = idle_func;
 153         transport->idle.private_data = private_data;
 154         transport->idle.period = period;
 155
 156         transport->idle.te = tevent_add_timer(transport->ev,
 157                                               transport,
 158                                               timeval_current_ofs_usec(period),
 159                                               idle_handler,
 160                                               transport);
 161 }
 162
 163 /*
 164   process some read/write requests that are pending
 165   return false if the socket is dead
 166 */
 167 _PUBLIC_ bool smbcli_transport_process(struct smbcli_transport *transport)
 168 {
 169         struct tevent_req *subreq = NULL;
 170         int ret;
 171
 172         if (!smbXcli_conn_is_connected(transport->conn)) {
 173                 return false;
 174         }
 175
 176         if (!smbXcli_conn_has_async_calls(transport->conn)) {
 177                 return true;
 178         }
 179
 180         /*
 181          * do not block for more than 500 micro seconds
 182          */
 183         subreq = tevent_wakeup_send(transport,
 184                                     transport->ev,
 185                                     timeval_current_ofs_usec(500));
 186         if (subreq == NULL) {
 187                 return false;
 188         }
 189
 190         ret = tevent_loop_once(transport->ev);
 191         if (ret != 0) {
 192                 return false;
 193         }
 194
 195         TALLOC_FREE(subreq);
 196
 197         if (!smbXcli_conn_is_connected(transport->conn)) {
 198                 return false;
 199         }
 200
 201         return true;
 202 }
 203
 204 static void smbcli_transport_break_handler(struct tevent_req *subreq);
 205 static void smbcli_request_done(struct tevent_req *subreq);
 206
 207 struct tevent_req *smbcli_transport_setup_subreq(struct smbcli_request *req)
 208 {
 209         struct smbcli_transport *transport = req->transport;
 210         uint8_t smb_command;
 211         uint8_t additional_flags;
 212         uint8_t clear_flags;
 213         uint16_t additional_flags2;
 214         uint16_t clear_flags2;
 215         uint32_t pid;
 216         uint16_t tid;
 217         uint16_t uid;
 218         uint32_t timeout_msec = transport->options.request_timeout * 1000;
 219         struct iovec *bytes_iov = NULL;
 220         struct tevent_req *subreq = NULL;
 221
 222         smb_command = SVAL(req->out.hdr, HDR_COM);
 223         additional_flags = CVAL(req->out.hdr, HDR_FLG);
 224         additional_flags2 = SVAL(req->out.hdr, HDR_FLG2);
 225         pid  = SVAL(req->out.hdr, HDR_PID);
 226         pid |= SVAL(req->out.hdr, HDR_PIDHIGH)<<16;
 227         tid = SVAL(req->out.hdr, HDR_TID);
 228         uid = SVAL(req->out.hdr, HDR_UID);
 229
 230         clear_flags = ~additional_flags;
 231         clear_flags2 = ~additional_flags2;
 232
 233         bytes_iov = talloc(req, struct iovec);
 234         if (bytes_iov == NULL) {
 235                 return NULL;
 236         }
 237         bytes_iov->iov_base = (void *)req->out.data;
 238         bytes_iov->iov_len = req->out.data_size;
 239
 240         subreq = smb1cli_req_create(req,
 241                                     transport->ev,
 242                                     transport->conn,
 243                                     smb_command,
 244                                     additional_flags,
 245                                     clear_flags,
 246                                     additional_flags2,
 247                                     clear_flags2,
 248                                     timeout_msec,
 249                                     pid,
 250                                     tid,
 251                                     uid,
 252                                     req->out.wct,
 253                                     (uint16_t *)req->out.vwv,
 254                                     1, bytes_iov);
 255         if (subreq == NULL) {
 256                 return NULL;
 257         }
 258
 259         ZERO_STRUCT(req->out);
 260
 261         return subreq;
 262 }
 263
 264 /*
 265   put a request into the send queue
 266 */
 267 void smbcli_transport_send(struct smbcli_request *req)
 268 {
 269         struct smbcli_transport *transport = req->transport;
 270         NTSTATUS status;
 271         bool need_pending_break = false;
 272         struct tevent_req *subreq = NULL;
 273         size_t i;
 274         size_t num_subreqs = 0;
 275
 276         if (transport->oplock.handler) {
 277                 need_pending_break = true;
 278         }
 279
 280         if (transport->break_subreq) {
 281                 need_pending_break = false;
 282         }
 283
 284         if (need_pending_break) {
 285                 subreq = smb1cli_req_create(transport,
 286                                             transport->ev,
 287                                             transport->conn,
 288                                             0, /* smb_command */
 289                                             0, /* additional_flags */
 290                                             0, /* clear_flags */
 291                                             0, /* additional_flags2 */
 292                                             0, /* clear_flags2 */
 293                                             0, /* timeout_msec */
 294                                             0, /* pid */
 295                                             0, /* tid */
 296                                             0, /* uid */
 297                                             0, /* wct */
 298                                             NULL, /* vwv */
 299                                             0, /* iov_count */
 300                                             NULL); /* bytes_iov */
 301                 if (subreq != NULL) {
 302                         smb1cli_req_set_mid(subreq, 0xFFFF);
 303                         smbXcli_req_set_pending(subreq);
 304                         tevent_req_set_callback(subreq,
 305                                                 smbcli_transport_break_handler,
 306                                                 transport);
 307                         transport->break_subreq = subreq;
 308                         subreq = NULL;
 309                 }
 310         }
 311
 312         subreq = smbcli_transport_setup_subreq(req);
 313         if (subreq == NULL) {
 314                 req->state = SMBCLI_REQUEST_ERROR;
 315                 req->status = NT_STATUS_NO_MEMORY;
 316                 return;
 317         }
 318
 319         for (i = 0; i < ARRAY_SIZE(req->subreqs); i++) {
 320                 if (req->subreqs[i] == NULL) {
 321                         req->subreqs[i] = subreq;
 322                         subreq = NULL;
 323                 }
 324                 if (req->subreqs[i] == NULL) {
 325                         break;
 326                 }
 327
 328                 if (!tevent_req_is_in_progress(req->subreqs[i])) {
 329                         req->state = SMBCLI_REQUEST_ERROR;
 330                         req->status = NT_STATUS_INTERNAL_ERROR;
 331                         return;
 332                 }
 333         }
 334         num_subreqs = i;
 335
 336         req->state = SMBCLI_REQUEST_RECV;
 337         tevent_req_set_callback(req->subreqs[0], smbcli_request_done, req);
 338
 339         status = smb1cli_req_chain_submit(req->subreqs, num_subreqs);
 340         if (!NT_STATUS_IS_OK(status)) {
 341                 req->status = status;
 342                 req->state = SMBCLI_REQUEST_ERROR;
 343                 smbXcli_conn_disconnect(transport->conn, status);
 344         }
 345 }
 346
 347 static void smbcli_request_done(struct tevent_req *subreq)
 348 {
 349         struct smbcli_request *req =
 350                 tevent_req_callback_data(subreq,
 351                 struct smbcli_request);
 352         struct smbcli_transport *transport = req->transport;
 353         ssize_t len;
 354         size_t i;
 355         uint8_t *hdr = NULL;
 356         uint8_t wct = 0;
 357         uint16_t *vwv = NULL;
 358         uint32_t num_bytes = 0;
 359         uint8_t *bytes = NULL;
 360         struct iovec *recv_iov = NULL;
 361         uint8_t *inbuf = NULL;
 362
 363         req->status = smb1cli_req_recv(req->subreqs[0], req,
 364                                        &recv_iov,
 365                                        &hdr,
 366                                        &wct,
 367                                        &vwv,
 368                                        NULL, /* pvwv_offset */
 369                                        &num_bytes,
 370                                        &bytes,
 371                                        NULL, /* pbytes_offset */
 372                                        &inbuf,
 373                                        NULL, 0); /* expected */
 374         TALLOC_FREE(req->subreqs[0]);
 375         if (!NT_STATUS_IS_OK(req->status)) {
 376                 if (recv_iov == NULL) {
 377                         req->state = SMBCLI_REQUEST_ERROR;
 378                         transport->error.e.nt_status = req->status;
 379                         transport->error.etype = ETYPE_SOCKET;
 380                         if (req->async.fn) {
 381                                 req->async.fn(req);
 382                         }
 383                         return;
 384                 }
 385         }
 386
 387         /*
 388          * For SMBreadBraw hdr is NULL
 389          */
 390         len = recv_iov[0].iov_len;
 391         for (i=1; hdr != NULL && i < 3; i++) {
 392                 uint8_t *p = recv_iov[i-1].iov_base;
 393                 uint8_t *c1 = recv_iov[i].iov_base;
 394                 uint8_t *c2 = p + recv_iov[i-1].iov_len;
 395
 396                 len += recv_iov[i].iov_len;
 397
 398                 c2 += i;
 399                 len += i;
 400
 401                 if (recv_iov[i].iov_len == 0) {
 402                         continue;
 403                 }
 404
 405                 if (c1 != c2) {
 406                         req->state = SMBCLI_REQUEST_ERROR;
 407                         req->status = NT_STATUS_INTERNAL_ERROR;
 408                         transport->error.e.nt_status = req->status;
 409                         transport->error.etype = ETYPE_SMB;
 410                         if (req->async.fn) {
 411                                 req->async.fn(req);
 412                         }
 413                         return;
 414                 }
 415         }
 416
 417         /* fill in the 'in' portion of the matching request */
 418         req->in.buffer = inbuf;
 419         req->in.size = NBT_HDR_SIZE + len;
 420         req->in.allocated = req->in.size;
 421
 422         req->in.hdr = hdr;
 423         req->in.vwv = (uint8_t *)vwv;
 424         req->in.wct = wct;
 425         req->in.data = bytes;
 426         req->in.data_size = num_bytes;
 427         req->in.ptr = req->in.data;
 428         if (hdr != NULL) {
 429                 req->flags2 = SVAL(req->in.hdr, HDR_FLG2);
 430         }
 431
 432         smb_setup_bufinfo(req);
 433
 434         transport->error.e.nt_status = req->status;
 435         if (NT_STATUS_IS_OK(req->status)) {
 436                 transport->error.etype = ETYPE_NONE;
 437         } else {
 438                 transport->error.etype = ETYPE_SMB;
 439         }
 440
 441         req->state = SMBCLI_REQUEST_DONE;
 442         if (req->async.fn) {
 443                 req->async.fn(req);
 444         }
 445 }
 446
 447 static void smbcli_transport_break_handler(struct tevent_req *subreq)
 448 {
 449         struct smbcli_transport *transport =
 450                 tevent_req_callback_data(subreq,
 451                 struct smbcli_transport);
 452         NTSTATUS status;
 453         struct iovec *recv_iov = NULL;
 454         uint8_t *hdr = NULL;
 455         uint16_t *vwv = NULL;
 456         const struct smb1cli_req_expected_response expected[] = {
 457         {
 458                 .status = NT_STATUS_OK,
 459                 .wct = 8,
 460         }
 461         };
 462         uint16_t tid;
 463         uint16_t fnum;
 464         uint8_t level;
 465
 466         transport->break_subreq = NULL;
 467
 468         status = smb1cli_req_recv(subreq, transport,
 469                                   &recv_iov,
 470                                   &hdr,
 471                                   NULL, /* pwct */
 472                                   &vwv,
 473                                   NULL, /* pvwv_offset */
 474                                   NULL, /* pnum_bytes */
 475                                   NULL, /* pbytes */
 476                                   NULL, /* pbytes_offset */
 477                                   NULL, /* pinbuf */
 478                                   expected,
 479                                   ARRAY_SIZE(expected));
 480         TALLOC_FREE(subreq);
 481         if (!NT_STATUS_IS_OK(status)) {
 482                 TALLOC_FREE(recv_iov);
 483                 smbcli_transport_dead(transport, status);
 484                 return;
 485         }
 486
 487         /*
 488          * Setup the subreq to handle the
 489          * next incoming SMB2 Break.
 490          */
 491         subreq = smb1cli_req_create(transport,
 492                                     transport->ev,
 493                                     transport->conn,
 494                                     0, /* smb_command */
 495                                     0, /* additional_flags */
 496                                     0, /* clear_flags */
 497                                     0, /* additional_flags2 */
 498                                     0, /* clear_flags2 */
 499                                     0, /* timeout_msec */
 500                                     0, /* pid */
 501                                     0, /* tid */
 502                                     0, /* uid */
 503                                     0, /* wct */
 504                                     NULL, /* vwv */
 505                                     0, /* iov_count */
 506                                     NULL); /* bytes_iov */
 507         if (subreq != NULL) {
 508                 smb1cli_req_set_mid(subreq, 0xFFFF);
 509                 smbXcli_req_set_pending(subreq);
 510                 tevent_req_set_callback(subreq,
 511                                         smbcli_transport_break_handler,
 512                                         transport);
 513                 transport->break_subreq = subreq;
 514         }
 515
 516         tid = SVAL(hdr, HDR_TID);
 517         fnum = SVAL(vwv+2, 0);
 518         level = CVAL(vwv+3, 1);
 519
 520         TALLOC_FREE(recv_iov);
 521
 522         if (transport->oplock.handler) {
 523                 transport->oplock.handler(transport, tid, fnum, level,
 524                                           transport->oplock.private_data);
 525         } else {
 526                 DEBUG(5,("Got SMB oplock break with no handler\n"));
 527         }
 528
 529 }
 530
 531
 532 /****************************************************************************
 533  Send an SMBecho (async send)
 534 *****************************************************************************/
 535 _PUBLIC_ struct smbcli_request *smb_raw_echo_send(struct smbcli_transport *transport,
 536                                          struct smb_echo *p)
 537 {
 538         struct smbcli_request *req;
 539
 540         req = smbcli_request_setup_transport(transport, SMBecho, 1, p->in.size);
 541         if (!req) return NULL;
 542
 543         SSVAL(req->out.vwv, VWV(0), p->in.repeat_count);
 544
 545         memcpy(req->out.data, p->in.data, p->in.size);
 546
 547         ZERO_STRUCT(p->out);
 548
 549         if (!smbcli_request_send(req)) {
 550                 smbcli_request_destroy(req);
 551                 return NULL;
 552         }
 553
 554         return req;
 555 }
 556
 557 /****************************************************************************
 558  raw echo interface (async recv)
 559 ****************************************************************************/
 560 NTSTATUS smb_raw_echo_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx,
 561                            struct smb_echo *p)
 562 {
 563         if (!smbcli_request_receive(req) ||
 564             smbcli_request_is_error(req)) {
 565                 goto failed;
 566         }
 567
 568         SMBCLI_CHECK_WCT(req, 1);
 569         p->out.count++;
 570         p->out.sequence_number = SVAL(req->in.vwv, VWV(0));
 571         p->out.size = req->in.data_size;
 572         talloc_free(p->out.data);
 573         p->out.data = talloc_array(mem_ctx, uint8_t, p->out.size);
 574         NT_STATUS_HAVE_NO_MEMORY(p->out.data);
 575
 576         if (!smbcli_raw_pull_data(&req->in.bufinfo, req->in.data, p->out.size, p->out.data)) {
 577                 req->status = NT_STATUS_BUFFER_TOO_SMALL;
 578         }
 579
 580         if (p->out.count == p->in.repeat_count) {
 581                 return smbcli_request_destroy(req);
 582         }
 583
 584         return NT_STATUS_OK;
 585
 586 failed:
 587         return smbcli_request_destroy(req);
 588 }
 589
 590 /****************************************************************************
 591  Send a echo (sync interface)
 592 *****************************************************************************/
 593 NTSTATUS smb_raw_echo(struct smbcli_transport *transport, struct smb_echo *p)
 594 {
 595         struct smbcli_request *req = smb_raw_echo_send(transport, p);
 596         return smbcli_request_simple_recv(req);
 597 }