source/libcli/smb2/smb2.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    SMB2 client library header
   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 "libcli/raw/request.h"
  23
  24 struct smb2_handle;
  25
  26 struct smb2_options {
  27         uint32_t timeout;
  28 };
  29
  30 /*
  31   information returned from the negotiate response
  32 */
  33 struct smb2_negotiate {
  34         DATA_BLOB secblob;
  35 };
  36
  37 /* this is the context for the smb2 transport layer */
  38 struct smb2_transport {
  39         /* socket level info */
  40         struct smbcli_socket *socket;
  41
  42         struct smb2_options options;
  43         struct smb2_negotiate negotiate;
  44
  45         /* next seqnum to allocate */
  46         uint64_t seqnum;
  47
  48         /* a list of requests that are pending for receive on this
  49            connection */
  50         struct smb2_request *pending_recv;
  51
  52         /* context of the stream -> packet parser */
  53         struct packet_context *packet;
  54
  55         /* an idle function - if this is defined then it will be
  56            called once every period microseconds while we are waiting
  57            for a packet */
  58         struct {
  59                 void (*func)(struct smb2_transport *, void *);
  60                 void *private;
  61                 uint_t period;
  62         } idle;
  63
  64         struct {
  65                 /* a oplock break request handler */
  66                 bool (*handler)(struct smb2_transport *transport,
  67                                 const struct smb2_handle *handle,
  68                                 uint8_t level, void *private_data);
  69                 /* private data passed to the oplock handler */
  70                 void *private_data;
  71         } oplock;
  72 };
  73
  74
  75 /*
  76   SMB2 tree context
  77 */
  78 struct smb2_tree {
  79         struct smb2_session *session;
  80         uint32_t tid;
  81 };
  82
  83 /*
  84   SMB2 session context
  85 */
  86 struct smb2_session {
  87         struct smb2_transport *transport;
  88         struct gensec_security *gensec;
  89         uint64_t uid;
  90         DATA_BLOB session_key;
  91 };
  92
  93
  94 struct smb2_request_buffer {
  95         /* the raw SMB2 buffer, including the 4 byte length header */
  96         uint8_t *buffer;
  97
  98         /* the size of the raw buffer, including 4 byte header */
  99         size_t size;
 100
 101         /* how much has been allocated - on reply the buffer is over-allocated to
 102            prevent too many realloc() calls
 103         */
 104         size_t allocated;
 105
 106         /* the start of the SMB2 header - this is always buffer+4 */
 107         uint8_t *hdr;
 108
 109         /* the packet body */
 110         uint8_t *body;
 111         size_t body_fixed;
 112         size_t body_size;
 113
 114         /* this point to the next dynamic byte that can be used
 115          * this will be moved when some dynamic data is pushed
 116          */
 117         uint8_t *dynamic;
 118
 119         /* this is used to range check and align strings and buffers */
 120         struct request_bufinfo bufinfo;
 121 };
 122
 123
 124 /*
 125   a client request moves between the following 4 states.
 126 */
 127 enum smb2_request_state {SMB2_REQUEST_INIT, /* we are creating the request */
 128                         SMB2_REQUEST_RECV, /* we are waiting for a matching reply */
 129                         SMB2_REQUEST_DONE, /* the request is finished */
 130                         SMB2_REQUEST_ERROR}; /* a packet or transport level error has occurred */
 131
 132 /* the context for a single SMB2 request */
 133 struct smb2_request {
 134         /* allow a request to be part of a list of requests */
 135         struct smb2_request *next, *prev;
 136
 137         /* each request is in one of 3 possible states */
 138         enum smb2_request_state state;
 139
 140         struct smb2_transport *transport;
 141         struct smb2_session   *session;
 142         struct smb2_tree      *tree;
 143
 144         uint64_t seqnum;
 145
 146         struct {
 147                 bool do_cancel;
 148                 bool can_cancel;
 149                 uint32_t pending_id;
 150         } cancel;
 151
 152         /* the NT status for this request. Set by packet receive code
 153            or code detecting error. */
 154         NTSTATUS status;
 155
 156         struct smb2_request_buffer in;
 157         struct smb2_request_buffer out;
 158
 159         /* information on what to do with a reply when it is received
 160            asyncronously. If this is not setup when a reply is received then
 161            the reply is discarded
 162
 163            The private pointer is private to the caller of the client
 164            library (the application), not private to the library
 165         */
 166         struct {
 167                 void (*fn)(struct smb2_request *);
 168                 void *private;
 169         } async;
 170 };
 171
 172
 173 #define SMB2_MIN_SIZE 0x42
 174
 175 /* offsets into header elements for a sync SMB2 request */
 176 #define SMB2_HDR_PROTOCOL_ID    0x00
 177 #define SMB2_HDR_LENGTH         0x04
 178 #define SMB2_HDR_EPOCH          0x06
 179 #define SMB2_HDR_STATUS         0x08
 180 #define SMB2_HDR_OPCODE         0x0c
 181 #define SMB2_HDR_CREDIT         0x0e
 182 #define SMB2_HDR_FLAGS          0x10
 183 #define SMB2_HDR_NEXT_COMMAND   0x14
 184 #define SMB2_HDR_MESSAGE_ID     0x18
 185 #define SMB2_HDR_PID            0x20
 186 #define SMB2_HDR_TID            0x24
 187 #define SMB2_HDR_SESSION_ID     0x28
 188 #define SMB2_HDR_SIGNATURE      0x30 /* 16 bytes */
 189 #define SMB2_HDR_BODY           0x40
 190
 191 /* SMB2 opcodes */
 192 #define SMB2_OP_NEGPROT   0x00
 193 #define SMB2_OP_SESSSETUP 0x01
 194 #define SMB2_OP_LOGOFF    0x02
 195 #define SMB2_OP_TCON      0x03
 196 #define SMB2_OP_TDIS      0x04
 197 #define SMB2_OP_CREATE    0x05
 198 #define SMB2_OP_CLOSE     0x06
 199 #define SMB2_OP_FLUSH     0x07
 200 #define SMB2_OP_READ      0x08
 201 #define SMB2_OP_WRITE     0x09
 202 #define SMB2_OP_LOCK      0x0a
 203 #define SMB2_OP_IOCTL     0x0b
 204 #define SMB2_OP_CANCEL    0x0c
 205 #define SMB2_OP_KEEPALIVE 0x0d
 206 #define SMB2_OP_FIND      0x0e
 207 #define SMB2_OP_NOTIFY    0x0f
 208 #define SMB2_OP_GETINFO   0x10
 209 #define SMB2_OP_SETINFO   0x11
 210 #define SMB2_OP_BREAK     0x12
 211
 212 #define SMB2_MAGIC 0x424D53FE /* 0xFE 'S' 'M' 'B' */
 213
 214 /* the dialect we support */
 215 #define SMB2_DIALECT_REVISION           0x202
 216
 217 /* SMB2 negotiate security_mode */
 218 #define SMB2_NEGOTIATE_SIGNING_ENABLED   0x01
 219 #define SMB2_NEGOTIATE_SIGNING_REQUIRED  0x02
 220
 221 /* SMB2 capabilities - only 1 so far. I'm sure more will be added */
 222 #define SMB2_CAP_DFS                     0x0
 223 /* so we can spot new caps as added */
 224 #define SMB2_CAP_ALL                     SMB2_CAP_DFS
 225
 226 /* SMB2 share flags */
 227 #define SMB2_SHAREFLAG_MANUAL_CACHING                    0x0000
 228 #define SMB2_SHAREFLAG_AUTO_CACHING                      0x0010
 229 #define SMB2_SHAREFLAG_VDO_CACHING                       0x0020
 230 #define SMB2_SHAREFLAG_NO_CACHING                        0x0030
 231 #define SMB2_SHAREFLAG_DFS                               0x0001
 232 #define SMB2_SHAREFLAG_DFS_ROOT                          0x0002
 233 #define SMB2_SHAREFLAG_RESTRICT_EXCLUSIVE_OPENS          0x0100
 234 #define SMB2_SHAREFLAG_FORCE_SHARED_DELETE               0x0200
 235 #define SMB2_SHAREFLAG_ALLOW_NAMESPACE_CACHING           0x0400
 236 #define SMB2_SHAREFLAG_ACCESS_BASED_DIRECTORY_ENUM       0x0800
 237 #define SMB2_SHAREFLAG_ALL                               0x0F33
 238
 239 /* SMB2 create security flags */
 240 #define SMB2_SECURITY_DYNAMIC_TRACKING                   0x01
 241 #define SMB2_SECURITY_EFFECTIVE_ONLY                     0x02
 242
 243 /* SMB2 requested oplock levels */
 244 #define SMB2_OPLOCK_LEVEL_NONE                           0x00
 245 #define SMB2_OPLOCK_LEVEL_II                             0x01
 246 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE                      0x08
 247 #define SMB2_OPLOCK_LEVEL_BATCH                          0x09
 248
 249 /* SMB2 impersonation levels */
 250 #define SMB2_IMPERSONATION_ANONYMOUS                     0x00
 251 #define SMB2_IMPERSONATION_IDENTIFICATION                0x01
 252 #define SMB2_IMPERSONATION_IMPERSONATION                 0x02
 253 #define SMB2_IMPERSONATION_DELEGATE                      0x03
 254
 255 /* SMB2 create tags */
 256 #define SMB2_CREATE_TAG_EXTA "ExtA"
 257 #define SMB2_CREATE_TAG_MXAC "MxAc"
 258 #define SMB2_CREATE_TAG_SECD "SecD"
 259 #define SMB2_CREATE_TAG_DHNQ "DHnQ"
 260 #define SMB2_CREATE_TAG_DHNC "DHnC"
 261 #define SMB2_CREATE_TAG_ALSI "AlSi"
 262 #define SMB2_CREATE_TAG_TWRP "TWrp"
 263 #define SMB2_CREATE_TAG_QFID "QFid"
 264
 265
 266
 267 /*
 268   check that a body has the expected size
 269 */
 270 #define SMB2_CHECK_PACKET_RECV(req, size, dynamic) do { \
 271         size_t is_size = req->in.body_size; \
 272         uint16_t field_size = SVAL(req->in.body, 0); \
 273         uint16_t want_size = ((dynamic)?(size)+1:(size)); \
 274         if (is_size < (size)) { \
 275                 DEBUG(0,("%s: buffer too small 0x%x. Expected 0x%x\n", \
 276                          __location__, (unsigned)is_size, (unsigned)want_size)); \
 277                 return NT_STATUS_BUFFER_TOO_SMALL; \
 278         }\
 279         if (field_size != want_size) { \
 280                 DEBUG(0,("%s: unexpected fixed body size 0x%x. Expected 0x%x\n", \
 281                          __location__, (unsigned)field_size, (unsigned)want_size)); \
 282                 return NT_STATUS_INVALID_PARAMETER; \
 283         } \
 284 } while (0)