source4/smb_server/smb2/smb2_server.h

   1 /*
   2    Unix SMB2 implementation.
   3
   4    Copyright (C) Stefan Metzmacher            2005
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 /* the context for a single SMB2 request. This is passed to any request-context
  21    functions */
  22 struct smb2srv_request {
  23         /* the smbsrv_connection needs a list of requests queued for send */
  24         struct smb2srv_request *next, *prev;
  25
  26         /* the server_context contains all context specific to this SMB socket */
  27         struct smbsrv_connection *smb_conn;
  28
  29         /* conn is only set for operations that have a valid TID */
  30         struct smbsrv_tcon *tcon;
  31
  32         /* the session context is derived from the vuid */
  33         struct smbsrv_session *session;
  34
  35 #define SMB2SRV_REQ_CTRL_FLAG_NOT_REPLY (1<<0)
  36         uint32_t control_flags;
  37
  38         /* the system time when the request arrived */
  39         struct timeval request_time;
  40
  41         /* a pointer to the per request union smb_* io structure */
  42         void *io_ptr;
  43
  44         /* the ntvfs_request */
  45         struct ntvfs_request *ntvfs;
  46
  47         /* Now the SMB2 specific stuff */
  48
  49         /* the status the backend returned */
  50         NTSTATUS status;
  51
  52         /* for matching request and reply */
  53         uint64_t seqnum;
  54
  55         /* the id that can be used to cancel the request */
  56         uint32_t pending_id;
  57
  58         /* the offset to the next SMB2 Header for chained requests */
  59         uint32_t chain_offset;
  60
  61         /* the status we return for following chained requests */
  62         NTSTATUS chain_status;
  63
  64         /* chained file handle */
  65         uint8_t _chained_file_handle[16];
  66         uint8_t *chained_file_handle;
  67
  68         bool is_signed;
  69
  70         struct smb2_request_buffer in;
  71         struct smb2_request_buffer out;
  72 };
  73
  74 struct smbsrv_request;
  75
  76 #include "smb_server/smb2/smb2_proto.h"
  77
  78 /* useful way of catching field size errors with file and line number */
  79 #define SMB2SRV_CHECK_BODY_SIZE(req, size, dynamic) do { \
  80         size_t is_size = req->in.body_size; \
  81         uint16_t field_size; \
  82         uint16_t want_size = ((dynamic)?(size)+1:(size)); \
  83         if (is_size < (size)) { \
  84                 DEBUG(0,("%s: buffer too small 0x%x. Expected 0x%x\n", \
  85                          __location__, (unsigned)is_size, (unsigned)want_size)); \
  86                 smb2srv_send_error(req,  NT_STATUS_INVALID_PARAMETER); \
  87                 return; \
  88         }\
  89         field_size = SVAL(req->in.body, 0);       \
  90         if (field_size != want_size) { \
  91                 DEBUG(0,("%s: unexpected fixed body size 0x%x. Expected 0x%x\n", \
  92                          __location__, (unsigned)field_size, (unsigned)want_size)); \
  93                 smb2srv_send_error(req,  NT_STATUS_INVALID_PARAMETER); \
  94                 return; \
  95         } \
  96 } while (0)
  97
  98 #define SMB2SRV_CHECK(cmd) do {\
  99         NTSTATUS _status; \
 100         _status = cmd; \
 101         if (!NT_STATUS_IS_OK(_status)) { \
 102                 smb2srv_send_error(req,  _status); \
 103                 return; \
 104         } \
 105 } while (0)
 106
 107 /* useful wrapper for talloc with NO_MEMORY reply */
 108 #define SMB2SRV_TALLOC_IO_PTR(ptr, type) do { \
 109         ptr = talloc(req, type); \
 110         if (!ptr) { \
 111                 smb2srv_send_error(req, NT_STATUS_NO_MEMORY); \
 112                 return; \
 113         } \
 114         req->io_ptr = ptr; \
 115 } while (0)
 116
 117 #define SMB2SRV_SETUP_NTVFS_REQUEST(send_fn, state) do { \
 118         req->ntvfs = ntvfs_request_create(req->tcon->ntvfs, req, \
 119                                           req->session->session_info,\
 120                                           0, \
 121                                           req->request_time, \
 122                                           req, send_fn, state); \
 123         if (!req->ntvfs) { \
 124                 smb2srv_send_error(req, NT_STATUS_NO_MEMORY); \
 125                 return; \
 126         } \
 127         (void)talloc_steal(req->tcon->ntvfs, req); \
 128         req->ntvfs->frontend_data.private_data = req; \
 129 } while (0)
 130
 131 #define SMB2SRV_CHECK_FILE_HANDLE(handle) do { \
 132         if (!handle) { \
 133                 smb2srv_send_error(req, NT_STATUS_FILE_CLOSED); \
 134                 return; \
 135         } \
 136 } while (0)
 137
 138 /*
 139    check if the backend wants to handle the request asynchronously.
 140    if it wants it handled synchronously then call the send function
 141    immediately
 142 */
 143 #define SMB2SRV_CALL_NTVFS_BACKEND(cmd) do { \
 144         req->ntvfs->async_states->status = cmd; \
 145         if (req->ntvfs->async_states->state & NTVFS_ASYNC_STATE_ASYNC) { \
 146                 NTSTATUS _status; \
 147                 _status = smb2srv_queue_pending(req); \
 148                 if (!NT_STATUS_IS_OK(_status)) { \
 149                         ntvfs_cancel(req->ntvfs); \
 150                 } \
 151         } else { \
 152                 req->ntvfs->async_states->send_fn(req->ntvfs); \
 153         } \
 154 } while (0)
 155
 156 /* check req->ntvfs->async_states->status and if not OK then send an error reply */
 157 #define SMB2SRV_CHECK_ASYNC_STATUS_ERR_SIMPLE do { \
 158         req = talloc_get_type(ntvfs->async_states->private_data, struct smb2srv_request); \
 159         if (ntvfs->async_states->state & NTVFS_ASYNC_STATE_CLOSE || NT_STATUS_EQUAL(ntvfs->async_states->status, NT_STATUS_NET_WRITE_FAULT)) { \
 160                 smbsrv_terminate_connection(req->smb_conn, get_friendly_nt_error_msg (ntvfs->async_states->status)); \
 161                 talloc_free(req); \
 162                 return; \
 163         } \
 164         req->status = ntvfs->async_states->status; \
 165         if (NT_STATUS_IS_ERR(ntvfs->async_states->status)) { \
 166                 smb2srv_send_error(req, ntvfs->async_states->status); \
 167                 return; \
 168         } \
 169 } while (0)
 170 #define SMB2SRV_CHECK_ASYNC_STATUS_ERR(ptr, type) do { \
 171         SMB2SRV_CHECK_ASYNC_STATUS_ERR_SIMPLE; \
 172         ptr = talloc_get_type(req->io_ptr, type); \
 173 } while (0)
 174 #define SMB2SRV_CHECK_ASYNC_STATUS_SIMPLE do { \
 175         req = talloc_get_type(ntvfs->async_states->private_data, struct smb2srv_request); \
 176         if (ntvfs->async_states->state & NTVFS_ASYNC_STATE_CLOSE || NT_STATUS_EQUAL(ntvfs->async_states->status, NT_STATUS_NET_WRITE_FAULT)) { \
 177                 smbsrv_terminate_connection(req->smb_conn, get_friendly_nt_error_msg (ntvfs->async_states->status)); \
 178                 talloc_free(req); \
 179                 return; \
 180         } \
 181         req->status = ntvfs->async_states->status; \
 182         if (!NT_STATUS_IS_OK(ntvfs->async_states->status)) { \
 183                 smb2srv_send_error(req, ntvfs->async_states->status); \
 184                 return; \
 185         } \
 186 } while (0)
 187 #define SMB2SRV_CHECK_ASYNC_STATUS(ptr, type) do { \
 188         SMB2SRV_CHECK_ASYNC_STATUS_SIMPLE; \
 189         ptr = talloc_get_type(req->io_ptr, type); \
 190 } while (0)