source4/libcli/smb2/transport.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    SMB2 client transport context management functions
   5
   6    Copyright (C) Andrew Tridgell 2005
   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 "libcli/raw/libcliraw.h"
  25 #include "libcli/raw/raw_proto.h"
  26 #include "libcli/smb2/smb2.h"
  27 #include "libcli/smb2/smb2_calls.h"
  28 #include "lib/socket/socket.h"
  29 #include "lib/events/events.h"
  30 #include "../lib/util/dlinklist.h"
  31 #include "../libcli/smb/smbXcli_base.h"
  32 #include "librpc/ndr/libndr.h"
  33
  34 /*
  35   destroy a transport
  36  */
  37 static int transport_destructor(struct smb2_transport *transport)
  38 {
  39         smb2_transport_dead(transport, NT_STATUS_LOCAL_DISCONNECT);
  40         return 0;
  41 }
  42
  43 /*
  44   create a transport structure based on an established socket
  45 */
  46 struct smb2_transport *smb2_transport_init(struct smbcli_socket *sock,
  47                                            TALLOC_CTX *parent_ctx,
  48                                            struct smbcli_options *options)
  49 {
  50         struct smb2_transport *transport;
  51         struct GUID client_guid;
  52         uint32_t smb2_capabilities = 0;
  53
  54         transport = talloc_zero(parent_ctx, struct smb2_transport);
  55         if (!transport) return NULL;
  56
  57         transport->ev = sock->event.ctx;
  58         transport->options = *options;
  59
  60         TALLOC_FREE(sock->event.fde);
  61         TALLOC_FREE(sock->event.te);
  62
  63         client_guid = GUID_random();
  64
  65         /* TODO: hand this in via the options? */
  66         smb2_capabilities = SMB2_CAP_ALL;
  67
  68         transport->conn = smbXcli_conn_create(transport,
  69                                               sock->sock->fd,
  70                                               sock->hostname,
  71                                               options->signing,
  72                                               0, /* smb1_capabilities */
  73                                               &client_guid,
  74                                               smb2_capabilities);
  75         if (transport->conn == NULL) {
  76                 talloc_free(transport);
  77                 return NULL;
  78         }
  79         sock->sock->fd = -1;
  80         TALLOC_FREE(sock);
  81
  82         talloc_set_destructor(transport, transport_destructor);
  83
  84         return transport;
  85 }
  86
  87 /*
  88   mark the transport as dead
  89 */
  90 void smb2_transport_dead(struct smb2_transport *transport, NTSTATUS status)
  91 {
  92         if (NT_STATUS_EQUAL(NT_STATUS_UNSUCCESSFUL, status)) {
  93                 status = NT_STATUS_UNEXPECTED_NETWORK_ERROR;
  94         }
  95         if (NT_STATUS_IS_OK(status)) {
  96                 status = NT_STATUS_LOCAL_DISCONNECT;
  97         }
  98
  99         smbXcli_conn_disconnect(transport->conn, status);
 100 }
 101
 102 static void smb2_request_done(struct tevent_req *subreq);
 103 static void smb2_transport_break_handler(struct tevent_req *subreq);
 104
 105 /*
 106   put a request into the send queue
 107 */
 108 void smb2_transport_send(struct smb2_request *req)
 109 {
 110         NTSTATUS status;
 111         struct smb2_transport *transport = req->transport;
 112         struct tevent_req **reqs = transport->compound.reqs;
 113         size_t num_reqs = talloc_array_length(reqs);
 114         size_t i;
 115         uint16_t cmd = SVAL(req->out.hdr, SMB2_HDR_OPCODE);
 116         uint32_t additional_flags = IVAL(req->out.hdr, SMB2_HDR_FLAGS);
 117         uint32_t clear_flags = 0;
 118         struct smbXcli_tcon *tcon = NULL;
 119         struct smbXcli_session *session = NULL;
 120         bool need_pending_break = false;
 121         size_t hdr_ofs;
 122         size_t pdu_len;
 123         DATA_BLOB body = data_blob_null;
 124         DATA_BLOB dyn = data_blob_null;
 125         uint32_t timeout_msec = transport->options.request_timeout * 1000;
 126
 127         if (transport->oplock.handler) {
 128                 need_pending_break = true;
 129         }
 130
 131         if (transport->lease.handler) {
 132                 need_pending_break = true;
 133         }
 134
 135         if (transport->break_subreq) {
 136                 need_pending_break = false;
 137         }
 138
 139         if (need_pending_break) {
 140                 struct tevent_req *subreq;
 141
 142                 subreq = smb2cli_req_create(transport,
 143                                             transport->ev,
 144                                             transport->conn,
 145                                             SMB2_OP_BREAK,
 146                                             0, /* additional_flags */
 147                                             0, /*clear_flags */
 148                                             0, /* timeout_msec */
 149                                             NULL, /* tcon */
 150                                             NULL, /* session */
 151                                             NULL, /* body */
 152                                             0, /* body_fixed */
 153                                             NULL, /* dyn */
 154                                             0, /* dyn_len */
 155                                             0); /* max_dyn_len */
 156                 if (subreq != NULL) {
 157                         smbXcli_req_set_pending(subreq);
 158                         tevent_req_set_callback(subreq,
 159                                                 smb2_transport_break_handler,
 160                                                 transport);
 161                         transport->break_subreq = subreq;
 162                 }
 163         }
 164
 165         if (req->session) {
 166                 session = req->session->smbXcli;
 167         }
 168
 169         if (req->tree) {
 170                 tcon = req->tree->smbXcli;
 171         }
 172
 173         if (transport->compound.related) {
 174                 additional_flags |= SMB2_HDR_FLAG_CHAINED;
 175         }
 176
 177         hdr_ofs = PTR_DIFF(req->out.hdr, req->out.buffer);
 178         pdu_len = req->out.size - hdr_ofs;
 179         body.data = req->out.body;
 180         body.length = req->out.body_fixed;
 181         dyn.data = req->out.body + req->out.body_fixed;
 182         dyn.length = pdu_len - (SMB2_HDR_BODY + req->out.body_fixed);
 183
 184         req->subreq = smb2cli_req_create(req,
 185                                          transport->ev,
 186                                          transport->conn,
 187                                          cmd,
 188                                          additional_flags,
 189                                          clear_flags,
 190                                          timeout_msec,
 191                                          tcon,
 192                                          session,
 193                                          body.data, body.length,
 194                                          dyn.data, dyn.length,
 195                                          0); /* max_dyn_len */
 196         if (req->subreq == NULL) {
 197                 req->state = SMB2_REQUEST_ERROR;
 198                 req->status = NT_STATUS_NO_MEMORY;
 199                 return;
 200         }
 201
 202         if (!tevent_req_is_in_progress(req->subreq)) {
 203                 req->state = SMB2_REQUEST_ERROR;
 204                 req->status = NT_STATUS_INTERNAL_ERROR;/* TODO */
 205                 return;
 206         }
 207
 208         tevent_req_set_callback(req->subreq, smb2_request_done, req);
 209
 210         smb2cli_req_set_notify_async(req->subreq);
 211         if (req->credit_charge) {
 212                 smb2cli_req_set_credit_charge(req->subreq, req->credit_charge);
 213         }
 214
 215         ZERO_STRUCT(req->out);
 216         req->state = SMB2_REQUEST_RECV;
 217
 218         if (num_reqs > 0) {
 219                 for (i=0; i < num_reqs; i++) {
 220                         if (reqs[i] != NULL) {
 221                                 continue;
 222                         }
 223
 224                         reqs[i] = req->subreq;
 225                         i++;
 226                         break;
 227                 }
 228
 229                 if (i < num_reqs) {
 230                         return;
 231                 }
 232         } else {
 233                 reqs = &req->subreq;
 234                 num_reqs = 1;
 235         }
 236         status = smb2cli_req_compound_submit(reqs, num_reqs);
 237
 238         TALLOC_FREE(transport->compound.reqs);
 239         transport->compound.related = false;
 240
 241         if (!NT_STATUS_IS_OK(status)) {
 242                 req->status = status;
 243                 req->state = SMB2_REQUEST_ERROR;
 244                 smbXcli_conn_disconnect(transport->conn, status);
 245         }
 246 }
 247
 248 static void smb2_request_done(struct tevent_req *subreq)
 249 {
 250         struct smb2_request *req =
 251                 tevent_req_callback_data(subreq,
 252                 struct smb2_request);
 253         ssize_t len;
 254         size_t i;
 255
 256         req->recv_iov = NULL;
 257
 258         req->status = smb2cli_req_recv(req->subreq, req, &req->recv_iov, NULL, 0);
 259         if (NT_STATUS_EQUAL(req->status, STATUS_PENDING)) {
 260                 req->cancel.can_cancel = true;
 261                 return;
 262         }
 263         TALLOC_FREE(req->subreq);
 264         if (!NT_STATUS_IS_OK(req->status)) {
 265                 if (req->recv_iov == NULL) {
 266                         req->state = SMB2_REQUEST_ERROR;
 267                         if (req->async.fn) {
 268                                 req->async.fn(req);
 269                         }
 270                         return;
 271                 }
 272         }
 273
 274         len = req->recv_iov[0].iov_len;
 275         for (i=1; i < 3; i++) {
 276                 uint8_t *p = req->recv_iov[i-1].iov_base;
 277                 uint8_t *c1 = req->recv_iov[i].iov_base;
 278                 uint8_t *c2 = p + req->recv_iov[i-1].iov_len;
 279
 280                 len += req->recv_iov[i].iov_len;
 281
 282                 if (req->recv_iov[i].iov_len == 0) {
 283                         continue;
 284                 }
 285
 286                 if (c1 != c2) {
 287                         req->status = NT_STATUS_INTERNAL_ERROR;
 288                         req->state = SMB2_REQUEST_ERROR;
 289                         if (req->async.fn) {
 290                                 req->async.fn(req);
 291                         }
 292                         return;
 293                 }
 294         }
 295
 296         req->in.buffer = req->recv_iov[0].iov_base;
 297         req->in.size = len;
 298         req->in.allocated = req->in.size;
 299
 300         req->in.hdr        =  req->recv_iov[0].iov_base;
 301         req->in.body       =  req->recv_iov[1].iov_base;
 302         req->in.dynamic    =  req->recv_iov[2].iov_base;
 303         req->in.body_fixed =  req->recv_iov[1].iov_len;
 304         req->in.body_size  =  req->in.body_fixed;
 305         req->in.body_size  += req->recv_iov[2].iov_len;
 306
 307         smb2_setup_bufinfo(req);
 308
 309         req->state = SMB2_REQUEST_DONE;
 310         if (req->async.fn) {
 311                 req->async.fn(req);
 312         }
 313 }
 314
 315 static void smb2_transport_break_handler(struct tevent_req *subreq)
 316 {
 317         struct smb2_transport *transport =
 318                 tevent_req_callback_data(subreq,
 319                 struct smb2_transport);
 320         NTSTATUS status;
 321         uint8_t *body;
 322         uint16_t len = 0;
 323         bool lease;
 324         struct iovec *recv_iov = NULL;
 325
 326         transport->break_subreq = NULL;
 327
 328         status = smb2cli_req_recv(subreq, transport, &recv_iov, NULL, 0);
 329         TALLOC_FREE(subreq);
 330         if (!NT_STATUS_IS_OK(status)) {
 331                 TALLOC_FREE(recv_iov);
 332                 smb2_transport_dead(transport, status);
 333                 return;
 334         }
 335
 336         /*
 337          * Setup the subreq to handle the
 338          * next incoming SMB2 Break.
 339          */
 340         subreq = smb2cli_req_create(transport,
 341                                     transport->ev,
 342                                     transport->conn,
 343                                     SMB2_OP_BREAK,
 344                                     0, /* additional_flags */
 345                                     0, /*clear_flags */
 346                                     0, /* timeout_msec */
 347                                     NULL, /* tcon */
 348                                     NULL, /* session */
 349                                     NULL, /* body */
 350                                     0, /* body_fixed */
 351                                     NULL, /* dyn */
 352                                     0, /* dyn_len */
 353                                     0); /* max_dyn_len */
 354         if (subreq != NULL) {
 355                 smbXcli_req_set_pending(subreq);
 356                 tevent_req_set_callback(subreq,
 357                                         smb2_transport_break_handler,
 358                                         transport);
 359                 transport->break_subreq = subreq;
 360         }
 361
 362         body = recv_iov[1].iov_base;
 363
 364         len = recv_iov[1].iov_len;
 365         if (recv_iov[1].iov_len >= 2) {
 366                 len = CVAL(body, 0x00);
 367                 if (len != recv_iov[1].iov_len) {
 368                         len = recv_iov[1].iov_len;
 369                 }
 370         }
 371
 372         if (len == 24) {
 373                 lease = false;
 374         } else if (len == 44) {
 375                 lease = true;
 376         } else {
 377                 DEBUG(1,("Discarding smb2 oplock reply of invalid size %u\n",
 378                         (unsigned)len));
 379                 TALLOC_FREE(recv_iov);
 380                 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
 381                 smb2_transport_dead(transport, status);
 382                 return;
 383         }
 384
 385         if (!lease && transport->oplock.handler) {
 386                 struct smb2_handle h;
 387                 uint8_t level;
 388
 389                 level = CVAL(body, 0x02);
 390                 smb2_pull_handle(body+0x08, &h);
 391
 392                 TALLOC_FREE(recv_iov);
 393
 394                 transport->oplock.handler(transport, &h, level,
 395                                           transport->oplock.private_data);
 396         } else if (lease && transport->lease.handler) {
 397                 struct smb2_lease_break lb;
 398
 399                 ZERO_STRUCT(lb);
 400                 lb.break_flags =                SVAL(body, 0x4);
 401                 memcpy(&lb.current_lease.lease_key, body+0x8,
 402                     sizeof(struct smb2_lease_key));
 403                 lb.current_lease.lease_state =  SVAL(body, 0x18);
 404                 lb.new_lease_state =            SVAL(body, 0x1C);
 405                 lb.break_reason =               SVAL(body, 0x20);
 406                 lb.access_mask_hint =           SVAL(body, 0x24);
 407                 lb.share_mask_hint =            SVAL(body, 0x28);
 408
 409                 TALLOC_FREE(recv_iov);
 410
 411                 transport->lease.handler(transport, &lb,
 412                     transport->lease.private_data);
 413         } else {
 414                 DEBUG(5,("Got SMB2 %s break with no handler\n",
 415                         lease ? "lease" : "oplock"));
 416         }
 417         TALLOC_FREE(recv_iov);
 418 }
 419
 420 NTSTATUS smb2_transport_compound_start(struct smb2_transport *transport,
 421                                        uint32_t num)
 422 {
 423         TALLOC_FREE(transport->compound.reqs);
 424         ZERO_STRUCT(transport->compound);
 425
 426         transport->compound.reqs = talloc_zero_array(transport,
 427                                                      struct tevent_req *,
 428                                                      num);
 429         if (transport->compound.reqs == NULL) {
 430                 return NT_STATUS_NO_MEMORY;
 431         }
 432
 433         return NT_STATUS_OK;
 434 }
 435
 436 void smb2_transport_compound_set_related(struct smb2_transport *transport,
 437                                          bool related)
 438 {
 439         transport->compound.related = related;
 440 }
 441
 442 void smb2_transport_credits_ask_num(struct smb2_transport *transport,
 443                                     uint16_t ask_num)
 444 {
 445         smb2cli_conn_set_max_credits(transport->conn, ask_num);
 446 }
 447
 448 static void idle_handler(struct tevent_context *ev,
 449                          struct tevent_timer *te, struct timeval t, void *private_data)
 450 {
 451         struct smb2_transport *transport = talloc_get_type(private_data,
 452                                                            struct smb2_transport);
 453         struct timeval next;
 454
 455         transport->idle.func(transport, transport->idle.private_data);
 456
 457         next = timeval_current_ofs_usec(transport->idle.period);
 458         transport->idle.te = tevent_add_timer(transport->ev,
 459                                               transport,
 460                                               next,
 461                                               idle_handler,
 462                                               transport);
 463 }
 464
 465 /*
 466   setup the idle handler for a transport
 467   the period is in microseconds
 468 */
 469 void smb2_transport_idle_handler(struct smb2_transport *transport,
 470                                  void (*idle_func)(struct smb2_transport *, void *),
 471                                  uint64_t period,
 472                                  void *private_data)
 473 {
 474         TALLOC_FREE(transport->idle.te);
 475
 476         transport->idle.func = idle_func;
 477         transport->idle.private_data = private_data;
 478         transport->idle.period = period;
 479
 480         transport->idle.te = tevent_add_timer(transport->ev,
 481                                               transport,
 482                                               timeval_current_ofs_usec(period),
 483                                               idle_handler,
 484                                               transport);
 485 }