2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 2003
5 Copyright (C) James J Myers 2003 <myersjj@samba.org>
6 Copyright (C) Stefan Metzmacher 2004-2005
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.
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.
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/>.
22 #include "libcli/raw/request.h"
23 #include "libcli/raw/interfaces.h"
24 #include "lib/events/events.h"
25 #include "lib/socket/socket.h"
26 #include "../lib/util/dlinklist.h"
29 this header declares the core context structures associated with smb
30 sockets, tree connects, requests etc
32 the idea is that we will eventually get rid of all our global
33 variables and instead store our state from structures hanging off
37 struct smbsrv_tcons_context {
38 /* an id tree used to allocate tids */
39 struct idr_context *idtree_tid;
41 /* this is the limit of vuid values for this connection */
42 uint32_t idtree_limit;
44 /* list of open tree connects */
45 struct smbsrv_tcon *list;
48 struct smbsrv_sessions_context {
49 /* an id tree used to allocate vuids */
50 /* this holds info on session vuids that are already
51 * validated for this VC */
52 struct idr_context *idtree_vuid;
54 /* this is the limit of vuid values for this connection */
55 uint64_t idtree_limit;
57 /* also kept as a link list so it can be enumerated by
58 the management code */
59 struct smbsrv_session *list;
62 struct smbsrv_handles_context {
63 /* an id tree used to allocate file handles */
64 struct idr_context *idtree_hid;
66 /* this is the limit of handle values for this context */
67 uint64_t idtree_limit;
69 /* also kept as a link list so it can be enumerated by
70 the management code */
71 struct smbsrv_handle *list;
74 /* the current user context for a request */
75 struct smbsrv_session {
76 struct smbsrv_session *prev, *next;
78 struct smbsrv_connection *smb_conn;
81 * in SMB2 tcons belong to just one session
82 * and not to the whole connection
84 struct smbsrv_tcons_context smb2_tcons;
87 * the open file handles for this session,
88 * used for SMBexit, SMBulogoff and SMB2 SessionLogoff
90 struct smbsrv_handle_session_item *handles;
93 * an index passed over the wire:
99 struct gensec_security *gensec_ctx;
101 struct auth_session_info *session_info;
108 /* some statistics for the management tools */
110 /* the time when the session setup started */
111 struct timeval connect_time;
112 /* the time when the session setup was finished */
113 struct timeval auth_time;
114 /* the time when the last request comes in */
115 struct timeval last_request_time;
119 /* we need a forward declaration of the ntvfs_ops strucutre to prevent
121 struct ntvfs_context;
124 struct smbsrv_tcon *next, *prev;
126 /* the server context that this was created on */
127 struct smbsrv_connection *smb_conn;
129 /* the open file handles on this tcon */
130 struct smbsrv_handles_context handles;
133 * an index passed over the wire:
137 uint32_t tid; /* an index passed over the wire (the TID) */
140 const char *share_name;
142 /* the NTVFS context - see source/ntvfs/ for details */
143 struct ntvfs_context *ntvfs;
145 /* some stuff to support share level security */
147 /* in share level security we need to fake up a session */
148 struct smbsrv_session *session;
151 /* some stuff to support share level security */
153 /* in SMB2 a tcon always belongs to one session */
154 struct smbsrv_session *session;
157 /* some statistics for the management tools */
159 /* the time when the tree connect started */
160 struct timeval connect_time;
161 /* the time when the last request comes in */
162 struct timeval last_request_time;
166 struct smbsrv_handle {
167 struct smbsrv_handle *next, *prev;
169 /* the tcon the handle belongs to */
170 struct smbsrv_tcon *tcon;
172 /* the session the handle was opened on */
173 struct smbsrv_session *session;
175 /* the smbpid used on the open, used for SMBexit */
179 * this is for adding the handle into a linked list
180 * on the smbsrv_session, we can't use *next,*prev
181 * for this because they're used for the linked list on the
184 struct smbsrv_handle_session_item {
185 struct smbsrv_handle_session_item *prev, *next;
186 struct smbsrv_handle *handle;
190 * the value passed over the wire
193 * Note: for SMB2 handles are 128 bit
194 * we'll fill them with
202 * the ntvfs handle passed to the ntvfs backend
204 struct ntvfs_handle *ntvfs;
206 /* some statistics for the management tools */
208 /* the time when the tree connect started */
209 struct timeval open_time;
210 /* the time when the last request comes in */
211 struct timeval last_use_time;
215 /* a set of flags to control handling of request structures */
216 #define SMBSRV_REQ_CONTROL_LARGE (1<<1) /* allow replies larger than max_xmit */
218 #define SMBSRV_REQ_DEFAULT_STR_FLAGS(req) (((req)->flags2 & FLAGS2_UNICODE_STRINGS) ? STR_UNICODE : STR_ASCII)
220 /* the context for a single SMB request. This is passed to any request-context
222 struct smbsrv_request {
223 /* the smbsrv_connection needs a list of requests queued for send */
224 struct smbsrv_request *next, *prev;
226 /* the server_context contains all context specific to this SMB socket */
227 struct smbsrv_connection *smb_conn;
229 /* conn is only set for operations that have a valid TID */
230 struct smbsrv_tcon *tcon;
232 /* the session context is derived from the vuid */
233 struct smbsrv_session *session;
235 /* a set of flags to control usage of the request. See SMBSRV_REQ_CONTROL_* */
236 uint32_t control_flags;
238 /* the system time when the request arrived */
239 struct timeval request_time;
241 /* a pointer to the per request union smb_* io structure */
244 /* the ntvfs_request */
245 struct ntvfs_request *ntvfs;
247 /* Now the SMB specific stuff */
249 /* the flags from the SMB request, in raw form (host byte order) */
252 /* this can contain a fnum from an earlier part of a chained
253 * message (such as an SMBOpenX), or -1 */
256 /* how far through the chain of SMB commands have we gone? */
257 unsigned chain_count;
259 /* the sequence number for signing */
262 struct smb_request_buffer in;
263 struct smb_request_buffer out;
266 enum security_types {SEC_SHARE,SEC_USER};
268 /* smb server context structure. This should contain all the state
269 * information associated with a SMB server connection
271 struct smbsrv_connection {
272 /* context that has been negotiated between the client and server */
274 /* have we already done the NBT session establishment? */
275 bool done_nbt_session;
277 /* only one negprot per connection is allowed */
280 /* multiple session setups are allowed, but some parameters are
281 ignored in any but the first */
285 * Size of data we can send to client. Set
286 * by the client for all protocols above CORE.
287 * Set by us for CORE protocol.
289 unsigned max_send; /* init to BUFFER_SIZE */
292 * Size of the data we can receive. Set by us.
293 * Can be modified by the max xmit parameter.
295 unsigned max_recv; /* init to BUFFER_SIZE */
297 /* the negotiatiated protocol */
298 enum protocol_types protocol;
300 /* authentication context for multi-part negprot */
301 struct auth_context *auth_context;
303 /* reference to the kerberos keytab, or machine trust account */
304 struct cli_credentials *server_credentials;
306 /* did we tell the client we support encrypted passwords? */
307 bool encrypted_passwords;
309 /* Did we choose SPNEGO, or perhaps raw NTLMSSP, or even no extended security at all? */
312 /* client capabilities */
313 uint32_t client_caps;
315 /* the timezone we sent to the client */
318 /* NBT names only set when done_nbt_session is true */
319 struct nbt_name *called_name;
320 struct nbt_name *calling_name;
323 /* the context associated with open tree connects on a smb socket, not for SMB2 */
324 struct smbsrv_tcons_context smb_tcons;
326 /* context associated with currently valid session setups */
327 struct smbsrv_sessions_context sessions;
330 * the server_context holds a linked list of pending requests,
331 * this is used for finding the request structures on ntcancel requests
334 struct smbsrv_request *requests;
337 * the server_context holds a linked list of pending requests,
338 * and an idtree for finding the request structures on SMB2 Cancel
342 /* an id tree used to allocate ids */
343 struct idr_context *idtree_req;
345 /* this is the limit of pending requests values for this connection */
346 uint32_t idtree_limit;
348 /* list of open tree connects */
349 struct smb2srv_request *list;
352 struct smb_signing_context signing;
354 struct stream_connection *connection;
356 /* this holds a partially received request */
357 struct packet_context *packet;
359 /* a list of partially received transaction requests */
360 struct smbsrv_trans_partial {
361 struct smbsrv_trans_partial *next, *prev;
362 struct smbsrv_request *req;
365 struct smb_trans2 *trans;
366 struct smb_nttrans *nttrans;
370 /* configuration parameters */
372 enum security_types security;
373 bool nt_status_support;
376 /* some statictics for the management tools */
378 /* the time when the client connects */
379 struct timeval connect_time;
380 /* the time when the last request comes in */
381 struct timeval last_request_time;
384 struct share_context *share_context;
386 struct loadparm_context *lp_ctx;
388 bool smb2_signing_required;
390 uint64_t highest_smb2_seqnum;
394 struct loadparm_context;
396 NTSTATUS smbsrv_add_socket(struct event_context *event_context,
397 struct loadparm_context *lp_ctx,
398 const struct model_ops *model_ops,
399 const char *address);
401 struct loadparm_context;
403 #include "smb_server/smb_server_proto.h"
404 #include "smb_server/smb/smb_proto.h"
406 /* useful way of catching wct errors with file and line number */
407 #define SMBSRV_CHECK_WCT(req, wcount) do { \
408 if ((req)->in.wct != (wcount)) { \
409 DEBUG(1,("Unexpected WCT %u at %s(%d) - expected %d\n", \
410 (req)->in.wct, __FILE__, __LINE__, wcount)); \
411 smbsrv_send_error(req, NT_STATUS_DOS(ERRSRV, ERRerror)); \
416 /* useful wrapper for talloc with NO_MEMORY reply */
417 #define SMBSRV_TALLOC_IO_PTR(ptr, type) do { \
418 ptr = talloc(req, type); \
420 smbsrv_send_error(req, NT_STATUS_NO_MEMORY); \
426 #define SMBSRV_SETUP_NTVFS_REQUEST(send_fn, state) do { \
427 req->ntvfs = ntvfs_request_create(req->tcon->ntvfs, req, \
428 req->session->session_info,\
429 SVAL(req->in.hdr,HDR_PID), \
431 req, send_fn, state); \
433 smbsrv_send_error(req, NT_STATUS_NO_MEMORY); \
436 (void)talloc_steal(req->tcon->ntvfs, req); \
437 req->ntvfs->frontend_data.private_data = req; \
440 #define SMBSRV_CHECK_FILE_HANDLE(handle) do { \
442 smbsrv_send_error(req, NT_STATUS_INVALID_HANDLE); \
447 #define SMBSRV_CHECK_FILE_HANDLE_ERROR(handle, _status) do { \
449 smbsrv_send_error(req, _status); \
454 #define SMBSRV_CHECK_FILE_HANDLE_NTSTATUS(handle) do { \
456 return NT_STATUS_INVALID_HANDLE; \
460 #define SMBSRV_CHECK(cmd) do {\
463 if (!NT_STATUS_IS_OK(_status)) { \
464 smbsrv_send_error(req, _status); \
470 check if the backend wants to handle the request asynchronously.
471 if it wants it handled synchronously then call the send function
474 #define SMBSRV_CALL_NTVFS_BACKEND(cmd) do { \
475 req->ntvfs->async_states->status = cmd; \
476 if (req->ntvfs->async_states->state & NTVFS_ASYNC_STATE_ASYNC) { \
477 DLIST_ADD_END(req->smb_conn->requests, req, struct smbsrv_request *); \
479 req->ntvfs->async_states->send_fn(req->ntvfs); \
483 /* check req->ntvfs->async_states->status and if not OK then send an error reply */
484 #define SMBSRV_CHECK_ASYNC_STATUS_ERR_SIMPLE do { \
485 req = talloc_get_type(ntvfs->async_states->private_data, struct smbsrv_request); \
486 if (ntvfs->async_states->state & NTVFS_ASYNC_STATE_CLOSE || NT_STATUS_EQUAL(ntvfs->async_states->status, NT_STATUS_NET_WRITE_FAULT)) { \
487 smbsrv_terminate_connection(req->smb_conn, get_friendly_nt_error_msg (ntvfs->async_states->status)); \
491 if (NT_STATUS_IS_ERR(ntvfs->async_states->status)) { \
492 smbsrv_send_error(req, ntvfs->async_states->status); \
496 #define SMBSRV_CHECK_ASYNC_STATUS_ERR(ptr, type) do { \
497 SMBSRV_CHECK_ASYNC_STATUS_ERR_SIMPLE; \
498 ptr = talloc_get_type(req->io_ptr, type); \
500 #define SMBSRV_CHECK_ASYNC_STATUS_SIMPLE do { \
501 req = talloc_get_type(ntvfs->async_states->private_data, struct smbsrv_request); \
502 if (ntvfs->async_states->state & NTVFS_ASYNC_STATE_CLOSE || NT_STATUS_EQUAL(ntvfs->async_states->status, NT_STATUS_NET_WRITE_FAULT)) { \
503 smbsrv_terminate_connection(req->smb_conn, get_friendly_nt_error_msg (ntvfs->async_states->status)); \
507 if (!NT_STATUS_IS_OK(ntvfs->async_states->status)) { \
508 smbsrv_send_error(req, ntvfs->async_states->status); \
512 #define SMBSRV_CHECK_ASYNC_STATUS(ptr, type) do { \
513 SMBSRV_CHECK_ASYNC_STATUS_SIMPLE; \
514 ptr = talloc_get_type(req->io_ptr, type); \
517 /* zero out some reserved fields in a reply */
518 #define SMBSRV_VWV_RESERVED(start, count) memset(req->out.vwv + VWV(start), 0, (count)*2)
520 #include "smb_server/service_smb_proto.h"