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 2 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, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 /* the context for a single SMB2 request. This is passed to any request-context
  22    functions */
  23 struct smb2srv_request {
  24         /* the smbsrv_connection needs a list of requests queued for send */
  25         struct smb2srv_request *next, *prev;
  26
  27         /* the server_context contains all context specific to this SMB socket */
  28         struct smbsrv_connection *smb_conn;
  29
  30         /* conn is only set for operations that have a valid TID */
  31         struct smbsrv_tcon *tcon;
  32
  33         /* the session context is derived from the vuid */
  34         struct smbsrv_session *session;
  35
  36 #define SMB2SRV_REQ_CTRL_FLAG_NOT_REPLY (1<<0)
  37         uint32_t control_flags;
  38
  39         /* the system time when the request arrived */
  40         struct timeval request_time;
  41
  42         /* a pointer to the per request union smb_* io structure */
  43         void *io_ptr;
  44
  45         /* the ntvfs_request */
  46         struct ntvfs_request *ntvfs;
  47
  48         /* Now the SMB2 specific stuff */
  49
  50         /* the status the backend returned */
  51         NTSTATUS status;
  52
  53         /* for matching request and reply */
  54         uint64_t seqnum;
  55
  56         /* the id that can be used to cancel the request */
  57         uint32_t pending_id;
  58
  59         struct smb2_request_buffer in;
  60         struct smb2_request_buffer out;
  61 };
  62
  63 struct smbsrv_request;
  64
  65 #include "smb_server/smb2/smb2_proto.h"
  66
  67 /* useful way of catching wct errors with file and line number */
  68 #define SMB2SRV_CHECK_BODY_SIZE(req, size, dynamic) do { \
  69         size_t is_size = req->in.body_size; \
  70         uint16_t field_size = SVAL(req->in.body, 0); \
  71         uint16_t want_size = ((dynamic)?(size)+1:(size)); \
  72         if (is_size < (size)) { \
  73                 DEBUG(0,("%s: buffer too small 0x%x. Expected 0x%x\n", \
  74                          __location__, is_size, want_size)); \
  75                 smb2srv_send_error(req,  NT_STATUS_FOOBAR); \
  76                 return; \
  77         }\
  78         if (field_size != want_size) { \
  79                 DEBUG(0,("%s: unexpected fixed body size 0x%x. Expected 0x%x\n", \
  80                          __location__, field_size, want_size)); \
  81                 smb2srv_send_error(req,  NT_STATUS_FOOBAR); \
  82                 return; \
  83         } \
  84 } while (0)
  85
  86 #define SMB2SRV_CHECK(cmd) do {\
  87         NTSTATUS _status; \
  88         _status = cmd; \
  89         if (!NT_STATUS_IS_OK(_status)) { \
  90                 smb2srv_send_error(req,  _status); \
  91                 return; \
  92         } \
  93 } while (0)
  94
  95 /* useful wrapper for talloc with NO_MEMORY reply */
  96 #define SMB2SRV_TALLOC_IO_PTR(ptr, type) do { \
  97         ptr = talloc(req, type); \
  98         if (!ptr) { \
  99                 smb2srv_send_error(req, NT_STATUS_NO_MEMORY); \
 100                 return; \
 101         } \
 102         req->io_ptr = ptr; \
 103 } while (0)
 104
 105 #define SMB2SRV_SETUP_NTVFS_REQUEST(send_fn, state) do { \
 106         req->ntvfs = ntvfs_request_create(req->tcon->ntvfs, req, \
 107                                           req->session->session_info,\
 108                                           0, \
 109                                           req->request_time, \
 110                                           req, send_fn, state); \
 111         if (!req->ntvfs) { \
 112                 smb2srv_send_error(req, NT_STATUS_NO_MEMORY); \
 113                 return; \
 114         } \
 115         (void)talloc_steal(req->tcon->ntvfs, req); \
 116         req->ntvfs->frontend_data.private_data = req; \
 117 } while (0)
 118
 119 #define SMB2SRV_CHECK_FILE_HANDLE(handle) do { \
 120         if (!handle) { \
 121                 smb2srv_send_error(req, NT_STATUS_FILE_CLOSED); \
 122                 return; \
 123         } \
 124 } while (0)
 125
 126 /*
 127    check if the backend wants to handle the request asynchronously.
 128    if it wants it handled synchronously then call the send function
 129    immediately
 130 */
 131 #define SMB2SRV_CALL_NTVFS_BACKEND(cmd) do { \
 132         req->ntvfs->async_states->status = cmd; \
 133         if (req->ntvfs->async_states->state & NTVFS_ASYNC_STATE_ASYNC) { \
 134                 NTSTATUS _status; \
 135                 _status = smb2srv_queue_pending(req); \
 136                 if (!NT_STATUS_IS_OK(_status)) { \
 137                         ntvfs_cancel(req->ntvfs); \
 138                 } \
 139         } else { \
 140                 req->ntvfs->async_states->send_fn(req->ntvfs); \
 141         } \
 142 } while (0)
 143
 144 /* check req->ntvfs->async_states->status and if not OK then send an error reply */
 145 #define SMB2SRV_CHECK_ASYNC_STATUS_ERR_SIMPLE do { \
 146         req = talloc_get_type(ntvfs->async_states->private_data, struct smb2srv_request); \
 147         req->status = ntvfs->async_states->status; \
 148         if (NT_STATUS_IS_ERR(ntvfs->async_states->status)) { \
 149                 smb2srv_send_error(req, ntvfs->async_states->status); \
 150                 return; \
 151         } \
 152 } while (0)
 153 #define SMB2SRV_CHECK_ASYNC_STATUS_ERR(ptr, type) do { \
 154         SMB2SRV_CHECK_ASYNC_STATUS_ERR_SIMPLE; \
 155         ptr = talloc_get_type(req->io_ptr, type); \
 156 } while (0)
 157 #define SMB2SRV_CHECK_ASYNC_STATUS_SIMPLE do { \
 158         req = talloc_get_type(ntvfs->async_states->private_data, struct smb2srv_request); \
 159         req->status = ntvfs->async_states->status; \
 160         if (!NT_STATUS_IS_OK(ntvfs->async_states->status)) { \
 161                 smb2srv_send_error(req, ntvfs->async_states->status); \
 162                 return; \
 163         } \
 164 } while (0)
 165 #define SMB2SRV_CHECK_ASYNC_STATUS(ptr, type) do { \
 166         SMB2SRV_CHECK_ASYNC_STATUS_SIMPLE; \
 167         ptr = talloc_get_type(req->io_ptr, type); \
 168 } while (0)