e1f2419fb9f2bc89736cac81d6853136359bcb93
[ira/wip.git] / libcli / smb / smb2_constants.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_CONSTANTS_H__
23 #define __LIBCLI_SMB2_SMB2_CONSTANTS_H__
24
25 /* offsets into header elements for a sync SMB2 request */
26 #define SMB2_HDR_PROTOCOL_ID    0x00
27 #define SMB2_HDR_LENGTH         0x04
28 #define SMB2_HDR_CREDIT_CHARGE  0x06
29 #define SMB2_HDR_EPOCH          SMB2_HDR_CREDIT_CHARGE /* TODO: remove this */
30 #define SMB2_HDR_STATUS         0x08
31 #define SMB2_HDR_OPCODE         0x0c
32 #define SMB2_HDR_CREDIT         0x0e
33 #define SMB2_HDR_FLAGS          0x10
34 #define SMB2_HDR_NEXT_COMMAND   0x14
35 #define SMB2_HDR_MESSAGE_ID     0x18
36 #define SMB2_HDR_PID            0x20
37 #define SMB2_HDR_TID            0x24
38 #define SMB2_HDR_SESSION_ID     0x28
39 #define SMB2_HDR_SIGNATURE      0x30 /* 16 bytes */
40 #define SMB2_HDR_BODY           0x40
41
42 /* offsets into header elements for an async SMB2 request */
43 #define SMB2_HDR_ASYNC_ID       0x20
44
45 /* header flags */
46 #define SMB2_HDR_FLAG_REDIRECT  0x01
47 #define SMB2_HDR_FLAG_ASYNC     0x02
48 #define SMB2_HDR_FLAG_CHAINED   0x04
49 #define SMB2_HDR_FLAG_SIGNED    0x08
50 #define SMB2_HDR_FLAG_DFS       0x10000000
51
52 /* SMB2 opcodes */
53 #define SMB2_OP_NEGPROT   0x00
54 #define SMB2_OP_SESSSETUP 0x01
55 #define SMB2_OP_LOGOFF    0x02
56 #define SMB2_OP_TCON      0x03
57 #define SMB2_OP_TDIS      0x04
58 #define SMB2_OP_CREATE    0x05
59 #define SMB2_OP_CLOSE     0x06
60 #define SMB2_OP_FLUSH     0x07
61 #define SMB2_OP_READ      0x08
62 #define SMB2_OP_WRITE     0x09
63 #define SMB2_OP_LOCK      0x0a
64 #define SMB2_OP_IOCTL     0x0b
65 #define SMB2_OP_CANCEL    0x0c
66 #define SMB2_OP_KEEPALIVE 0x0d
67 #define SMB2_OP_FIND      0x0e
68 #define SMB2_OP_NOTIFY    0x0f
69 #define SMB2_OP_GETINFO   0x10
70 #define SMB2_OP_SETINFO   0x11
71 #define SMB2_OP_BREAK     0x12
72
73 #define SMB2_MAGIC 0x424D53FE /* 0xFE 'S' 'M' 'B' */
74
75 /* SMB2 negotiate dialects */
76 #define SMB2_DIALECT_REVISION_000       0x0000 /* early beta dialect */
77 #define SMB2_DIALECT_REVISION_202       0x0202
78 #define SMB2_DIALECT_REVISION_210       0x0210
79 #define SMB2_DIALECT_REVISION_222       0x0222
80 #define SMB2_DIALECT_REVISION_224       0x0224
81 #define SMB2_DIALECT_REVISION_2FF       0x02FF
82
83 /* SMB2 negotiate security_mode */
84 #define SMB2_NEGOTIATE_SIGNING_ENABLED   0x01
85 #define SMB2_NEGOTIATE_SIGNING_REQUIRED  0x02
86
87 /* SMB2 capabilities - only 1 so far. I'm sure more will be added */
88 #define SMB2_CAP_DFS                     0x00000001
89 #define SMB2_CAP_LEASING                 0x00000002 /* only in dialect 0x210 */
90 #define SMB2_CAP_LARGE_MTU               0x00000004 /* only in dialect 0x210 */
91 /* so we can spot new caps as added */
92 #define SMB2_CAP_ALL                     SMB2_CAP_DFS
93
94 /* SMB2 session flags */
95 #define SMB2_SESSION_FLAG_IS_GUEST       0x0001
96 #define SMB2_SESSION_FLAG_IS_NULL        0x0002
97
98 /* SMB2 sharetype flags */
99 #define SMB2_SHARE_TYPE_DISK            0x1
100 #define SMB2_SHARE_TYPE_PIPE            0x2
101 #define SMB2_SHARE_TYPE_PRINT           0x3
102
103 /* SMB2 share flags */
104 #define SMB2_SHAREFLAG_MANUAL_CACHING                    0x0000
105 #define SMB2_SHAREFLAG_AUTO_CACHING                      0x0010
106 #define SMB2_SHAREFLAG_VDO_CACHING                       0x0020
107 #define SMB2_SHAREFLAG_NO_CACHING                        0x0030
108 #define SMB2_SHAREFLAG_DFS                               0x0001
109 #define SMB2_SHAREFLAG_DFS_ROOT                          0x0002
110 #define SMB2_SHAREFLAG_RESTRICT_EXCLUSIVE_OPENS          0x0100
111 #define SMB2_SHAREFLAG_FORCE_SHARED_DELETE               0x0200
112 #define SMB2_SHAREFLAG_ALLOW_NAMESPACE_CACHING           0x0400
113 #define SMB2_SHAREFLAG_ACCESS_BASED_DIRECTORY_ENUM       0x0800
114 #define SMB2_SHAREFLAG_ALL                               0x0F33
115
116 /* SMB2 share capabilities */
117 #define SMB2_SHARE_CAP_DFS              0x8
118
119 /* SMB2 create security flags */
120 #define SMB2_SECURITY_DYNAMIC_TRACKING                   0x01
121 #define SMB2_SECURITY_EFFECTIVE_ONLY                     0x02
122
123 /* SMB2 lock flags */
124 #define SMB2_LOCK_FLAG_NONE             0x00000000
125 #define SMB2_LOCK_FLAG_SHARED           0x00000001
126 #define SMB2_LOCK_FLAG_EXCLUSIVE        0x00000002
127 #define SMB2_LOCK_FLAG_UNLOCK           0x00000004
128 #define SMB2_LOCK_FLAG_FAIL_IMMEDIATELY 0x00000010
129 #define SMB2_LOCK_FLAG_ALL_MASK         0x00000017
130
131 /* SMB2 requested oplock levels */
132 #define SMB2_OPLOCK_LEVEL_NONE                           0x00
133 #define SMB2_OPLOCK_LEVEL_II                             0x01
134 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE                      0x08
135 #define SMB2_OPLOCK_LEVEL_BATCH                          0x09
136 #define SMB2_OPLOCK_LEVEL_LEASE                          0xFF
137
138 /* SMB2 lease bits */
139 #define SMB2_LEASE_NONE                                  0x00
140 #define SMB2_LEASE_READ                                  0x01
141 #define SMB2_LEASE_HANDLE                                0x02
142 #define SMB2_LEASE_WRITE                                 0x04
143
144 /* SMB2 lease break flags */
145 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED        0x01
146
147 /* SMB2 impersonation levels */
148 #define SMB2_IMPERSONATION_ANONYMOUS                     0x00
149 #define SMB2_IMPERSONATION_IDENTIFICATION                0x01
150 #define SMB2_IMPERSONATION_IMPERSONATION                 0x02
151 #define SMB2_IMPERSONATION_DELEGATE                      0x03
152
153 /* SMB2 create tags */
154 #define SMB2_CREATE_TAG_EXTA "ExtA"
155 #define SMB2_CREATE_TAG_MXAC "MxAc"
156 #define SMB2_CREATE_TAG_SECD "SecD"
157 #define SMB2_CREATE_TAG_DHNQ "DHnQ"
158 #define SMB2_CREATE_TAG_DHNC "DHnC"
159 #define SMB2_CREATE_TAG_ALSI "AlSi"
160 #define SMB2_CREATE_TAG_TWRP "TWrp"
161 #define SMB2_CREATE_TAG_QFID "QFid"
162 #define SMB2_CREATE_TAG_RQLS "RqLs"
163 #define SMB2_CREATE_TAG_DH2Q "DH2Q"
164 #define SMB2_CREATE_TAG_DH2C "DH2C"
165
166 /* SMB2 notify flags */
167 #define SMB2_WATCH_TREE 0x0001
168
169 /* SMB2 Create ignore some more create_options */
170 #define SMB2_CREATE_OPTIONS_NOT_SUPPORTED_MASK  (NTCREATEX_OPTIONS_TREE_CONNECTION | \
171                                                  NTCREATEX_OPTIONS_OPFILTER)
172
173 /*
174   SMB2 uses different level numbers for the same old SMB trans2 search levels
175 */
176 #define SMB2_FIND_DIRECTORY_INFO         0x01
177 #define SMB2_FIND_FULL_DIRECTORY_INFO    0x02
178 #define SMB2_FIND_BOTH_DIRECTORY_INFO    0x03
179 #define SMB2_FIND_NAME_INFO              0x0C
180 #define SMB2_FIND_ID_BOTH_DIRECTORY_INFO 0x25
181 #define SMB2_FIND_ID_FULL_DIRECTORY_INFO 0x26
182
183 /* flags for SMB2 find */
184 #define SMB2_CONTINUE_FLAG_RESTART    0x01
185 #define SMB2_CONTINUE_FLAG_SINGLE     0x02
186 #define SMB2_CONTINUE_FLAG_INDEX      0x04
187 #define SMB2_CONTINUE_FLAG_REOPEN     0x10
188
189 /* getinfo classes */
190 #define SMB2_GETINFO_FILE               0x01
191 #define SMB2_GETINFO_FS                 0x02
192 #define SMB2_GETINFO_SECURITY           0x03
193 #define SMB2_GETINFO_QUOTA              0x04
194
195 #define SMB2_CLOSE_FLAGS_FULL_INFORMATION (0x01)
196
197 #define SMB2_WRITEFLAG_WRITE_THROUGH    0x00000001
198
199 #endif