libcli/smb/smb_constants.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    SMB parameters and setup, plus a whole lot more.
   5
   6    Copyright (C) Andrew Tridgell              2011
   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 _SMB_CONSTANTS_H
  23 #define _SMB_CONSTANTS_H
  24
  25 /*
  26  * Netbios over TCP (rfc 1002)
  27  */
  28 #define NBSSmessage     0x00   /* session message */
  29 #define NBSSrequest     0x81   /* session request */
  30 #define NBSSpositive    0x82   /* positiv session response */
  31 #define NBSSnegative    0x83   /* negativ session response */
  32 #define NBSSretarget    0x84   /* retarget session response */
  33 #define NBSSkeepalive   0x85   /* keepalive */
  34
  35 #define SMB_MAGIC 0x424D53FF /* 0xFF 'S' 'M' 'B' */
  36
  37 /* the basic packet size, assuming no words or bytes. Does not include the NBT header */
  38 #define MIN_SMB_SIZE 35
  39
  40 /* when using NBT encapsulation every packet has a 4 byte header */
  41 #define NBT_HDR_SIZE 4
  42
  43 /* offsets into message header for common items - NOTE: These have
  44    changed from being offsets from the base of the NBT packet to the base of the SMB packet.
  45    this has reduced all these values by 4
  46 */
  47 #define HDR_COM 4
  48 #define HDR_RCLS 5
  49 #define HDR_REH 6
  50 #define HDR_ERR 7
  51 #define HDR_FLG 9
  52 #define HDR_FLG2 10
  53 #define HDR_PIDHIGH 12
  54 #define HDR_SS_FIELD 14
  55 #define HDR_TID 24
  56 #define HDR_PID 26
  57 #define HDR_UID 28
  58 #define HDR_MID 30
  59 #define HDR_WCT 32
  60 #define HDR_VWV 33
  61
  62 #define smb_len_nbt(buf) (RIVAL(buf, 0) & 0x1FFFF)
  63 #define _smb_setlen_nbt(buf,len) RSIVAL(buf, 0, (len) & 0x1FFFF)
  64 #define smb_setlen_nbt(buf, len) do { \
  65         _smb_setlen_nbt(buf, len); \
  66         SIVAL(buf, 4, SMB_MAGIC); \
  67 } while (0)
  68
  69 #define smb_len_tcp(buf) (RIVAL(buf, 0) & 0xFFFFFF)
  70 #define _smb_setlen_tcp(buf,len) RSIVAL(buf, 0, (len) & 0xFFFFFF)
  71 #define smb_setlen_tcp(buf, len) do { \
  72         _smb_setlen_tcp(buf, len); \
  73         SIVAL(buf, 4, SMB_MAGIC); \
  74 } while (0)
  75
  76 /* protocol types. It assumes that higher protocols include lower protocols
  77    as subsets. */
  78 enum protocol_types {
  79         PROTOCOL_NONE,
  80         PROTOCOL_CORE,
  81         PROTOCOL_COREPLUS,
  82         PROTOCOL_LANMAN1,
  83         PROTOCOL_LANMAN2,
  84         PROTOCOL_NT1,
  85         PROTOCOL_SMB2_02,
  86         PROTOCOL_SMB2_10,
  87         PROTOCOL_SMB2_22
  88 };
  89
  90 enum smb_signing_setting {
  91         SMB_SIGNING_OFF, SMB_SIGNING_SUPPORTED,
  92         SMB_SIGNING_REQUIRED, SMB_SIGNING_AUTO};
  93
  94 /* Client-side offline caching policy types */
  95 enum csc_policy {
  96         CSC_POLICY_MANUAL=0,
  97         CSC_POLICY_DOCUMENTS=1,
  98         CSC_POLICY_PROGRAMS=2,
  99         CSC_POLICY_DISABLE=3
 100 };
 101
 102 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
 103 #define FLAGS2_LONG_PATH_COMPONENTS    0x0001
 104 #define FLAGS2_EXTENDED_ATTRIBUTES     0x0002
 105 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
 106 #define FLAGS2_SMB_SECURITY_SIGNATURES_REQUIRED 0x0010
 107 #define FLAGS2_IS_LONG_NAME            0x0040
 108 #define FLAGS2_EXTENDED_SECURITY       0x0800
 109 #define FLAGS2_DFS_PATHNAMES           0x1000
 110 #define FLAGS2_READ_PERMIT_EXECUTE     0x2000
 111 #define FLAGS2_32_BIT_ERROR_CODES      0x4000
 112 #define FLAGS2_UNICODE_STRINGS         0x8000
 113 #define FLAGS2_WIN2K_SIGNATURE         0xC852 /* Hack alert ! For now... JRA. */
 114
 115 /* FileAttributes (search attributes) field */
 116 #define FILE_ATTRIBUTE_READONLY         0x0001L
 117 #define FILE_ATTRIBUTE_HIDDEN           0x0002L
 118 #define FILE_ATTRIBUTE_SYSTEM           0x0004L
 119 #define FILE_ATTRIBUTE_VOLUME           0x0008L
 120 #define FILE_ATTRIBUTE_DIRECTORY        0x0010L
 121 #define FILE_ATTRIBUTE_ARCHIVE          0x0020L
 122 #define FILE_ATTRIBUTE_DEVICE           0x0040L
 123 #define FILE_ATTRIBUTE_NORMAL           0x0080L
 124 #define FILE_ATTRIBUTE_TEMPORARY        0x0100L
 125 #define FILE_ATTRIBUTE_SPARSE           0x0200L
 126 #define FILE_ATTRIBUTE_REPARSE_POINT    0x0400L
 127 #define FILE_ATTRIBUTE_COMPRESSED       0x0800L
 128 #define FILE_ATTRIBUTE_OFFLINE          0x1000L
 129 #define FILE_ATTRIBUTE_NONINDEXED       0x2000L
 130 #define FILE_ATTRIBUTE_ENCRYPTED        0x4000L
 131 #define FILE_ATTRIBUTE_ALL_MASK         0x7FFFL
 132
 133 #define SAMBA_ATTRIBUTES_MASK           (FILE_ATTRIBUTE_READONLY|\
 134                                         FILE_ATTRIBUTE_HIDDEN|\
 135                                         FILE_ATTRIBUTE_SYSTEM|\
 136                                         FILE_ATTRIBUTE_DIRECTORY|\
 137                                         FILE_ATTRIBUTE_ARCHIVE)
 138
 139 /* File type flags */
 140 #define FILE_TYPE_DISK  0
 141 #define FILE_TYPE_BYTE_MODE_PIPE 1
 142 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
 143 #define FILE_TYPE_PRINTER 3
 144 #define FILE_TYPE_COMM_DEVICE 4
 145 #define FILE_TYPE_UNKNOWN 0xFFFF
 146
 147 /* ioctl codes */
 148 #define IOCTL_QUERY_JOB_INFO      0x530060
 149
 150 /* filesystem control codes */
 151 #define FSCTL_METHOD_BUFFERED   0x00000000
 152 #define FSCTL_METHOD_IN_DIRECT  0x00000001
 153 #define FSCTL_METHOD_OUT_DIRECT 0x00000002
 154 #define FSCTL_METHOD_NEITHER    0x00000003
 155
 156 #define FSCTL_ACCESS_ANY        0x00000000
 157 #define FSCTL_ACCESS_READ       0x00004000
 158 #define FSCTL_ACCESS_WRITE      0x00008000
 159
 160 #define FSCTL_DFS                       0x00060000
 161 #define FSCTL_DFS_GET_REFERRALS         (FSCTL_DFS | FSCTL_ACCESS_ANY | 0x0194 | FSCTL_METHOD_BUFFERED)
 162
 163 #define FSCTL_FILESYSTEM                0x00090000
 164 #define FSCTL_REQUEST_OPLOCK_LEVEL_1    (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0000 | FSCTL_METHOD_BUFFERED)
 165 #define FSCTL_REQUEST_OPLOCK_LEVEL_2    (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0004 | FSCTL_METHOD_BUFFERED)
 166 #define FSCTL_REQUEST_BATCH_OPLOCK      (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0008 | FSCTL_METHOD_BUFFERED)
 167 #define FSCTL_OPLOCK_BREAK_ACKNOWLEDGE  (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x000C | FSCTL_METHOD_BUFFERED)
 168 #define FSCTL_OPBATCH_ACK_CLOSE_PENDING (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0010 | FSCTL_METHOD_BUFFERED)
 169 #define FSCTL_OPLOCK_BREAK_NOTIFY       (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0014 | FSCTL_METHOD_BUFFERED)
 170 #define FSCTL_FILESYS_GET_STATISTICS    (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0060 | FSCTL_METHOD_BUFFERED)
 171 #define FSCTL_GET_NTFS_VOLUME_DATA      (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0064 | FSCTL_METHOD_BUFFERED)
 172 #define FSCTL_IS_VOLUME_DIRTY           (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0078 | FSCTL_METHOD_BUFFERED)
 173 #define FSCTL_FIND_FILES_BY_SID         (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x008C | FSCTL_METHOD_NEITHER)
 174 #define FSCTL_SET_OBJECT_ID             (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0098 | FSCTL_METHOD_BUFFERED)
 175 #define FSCTL_GET_OBJECT_ID             (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x009C | FSCTL_METHOD_BUFFERED)
 176 #define FSCTL_DELETE_OBJECT_ID          (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x00A0 | FSCTL_METHOD_BUFFERED)
 177 #define FSCTL_SET_REPARSE_POINT         (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x00A4 | FSCTL_METHOD_BUFFERED)
 178 #define FSCTL_GET_REPARSE_POINT         (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x00A8 | FSCTL_METHOD_BUFFERED)
 179 #define FSCTL_DELETE_REPARSE_POINT      (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x00AC | FSCTL_METHOD_BUFFERED)
 180 #define FSCTL_CREATE_OR_GET_OBJECT_ID   (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x00C0 | FSCTL_METHOD_BUFFERED)
 181 #define FSCTL_SET_SPARSE                (FSCTL_FILESYSTEM | FSCTL_ACCESS_ANY | 0x00C4 | FSCTL_METHOD_BUFFERED)
 182 #define FSCTL_QUERY_ALLOCATED_RANGES    (FSCTL_FILESYSTEM | FSCTL_ACCESS_READ | 0x00CC | FSCTL_METHOD_NEITHER)
 183
 184 #define FSCTL_NAMED_PIPE                0x00110000
 185 #define FSCTL_PIPE_PEEK                 (FSCTL_NAMED_PIPE | FSCTL_ACCESS_READ | 0x000C | FSCTL_METHOD_BUFFERED)
 186 #define FSCTL_NAMED_PIPE_READ_WRITE     (FSCTL_NAMED_PIPE | FSCTL_ACCESS_READ \
 187                                                           | FSCTL_ACCESS_WRITE | 0x0014 | FSCTL_METHOD_NEITHER)
 188 #define FSCTL_PIPE_TRANSCEIVE           FSCTL_NAMED_PIPE_READ_WRITE     /* SMB2 function name */
 189 #define FSCTL_PIPE_WAIT                 (FSCTL_NAMED_PIPE | FSCTL_ACCESS_ANY | 0x0018 | FSCTL_METHOD_BUFFERED)
 190
 191 #define FSCTL_NETWORK_FILESYSTEM        0x00140000
 192 #define FSCTL_GET_SHADOW_COPY_DATA      (FSCTL_NETWORK_FILESYSTEM | FSCTL_ACCESS_READ | 0x0064 | FSCTL_METHOD_BUFFERED)
 193 #define FSCTL_SRV_ENUM_SNAPS            FSCTL_GET_SHADOW_COPY_DATA      /* SMB2 function name */
 194 #define FSCTL_SRV_REQUEST_RESUME_KEY    (FSCTL_NETWORK_FILESYSTEM | FSCTL_ACCESS_ANY | 0x0078 | FSCTL_METHOD_BUFFERED)
 195 #define FSCTL_SRV_COPYCHUNK             (FSCTL_NETWORK_FILESYSTEM | FSCTL_ACCESS_READ | 0x00F0 | FSCTL_METHOD_OUT_DIRECT)
 196 #define FSCTL_SRV_COPYCHUNK_WRITE       (FSCTL_NETWORK_FILESYSTEM | FSCTL_ACCESS_WRITE | 0x00F0 | FSCTL_METHOD_OUT_DIRECT)
 197 #define FSCTL_SRV_READ_HASH             (FSCTL_NETWORK_FILESYSTEM | FSCTL_ACCESS_READ| 0x01B8 | FSCTL_METHOD_NEITHER)
 198 #define FSCTL_LMR_REQ_RESILIENCY        (FSCTL_NETWORK_FILESYSTEM | FSCTL_ACCESS_ANY | 0x01D4 | FSCTL_METHOD_BUFFERED)
 199
 200 #endif /* _SMB_CONSTANTS_H */