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