security: Add documentation
[Samba/gbeck.git] / source3 / smbd / globals.h
blob4a86697d48d29a1a4f9ef4c7124606db32730888
1 /*
2 Unix SMB/Netbios implementation.
3 smbd globals
4 Copyright (C) Stefan Metzmacher 2009
5 Copyright (C) Jeremy Allison 2010
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "system/select.h"
22 #include "librpc/gen_ndr/smbXsrv.h"
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
27 #ifdef USE_DMAPI
28 struct smbd_dmapi_context;
29 extern struct smbd_dmapi_context *dmapi_ctx;
30 #endif
32 extern bool dfree_broken;
34 /* how many write cache buffers have been allocated */
35 extern unsigned int allocated_write_caches;
37 /* A singleton cache to speed up searching by dev/inode. */
38 struct fsp_singleton_cache {
39 files_struct *fsp;
40 struct file_id id;
43 extern const struct mangle_fns *mangle_fns;
45 extern unsigned char *chartest;
46 struct tdb_context;
47 extern struct tdb_context *tdb_mangled_cache;
50 this determines how many characters are used from the original filename
51 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
52 The largest possible value is 6.
54 extern unsigned mangle_prefix;
56 struct msg_state;
58 extern bool logged_ioctl_message;
60 extern int trans_num;
62 extern time_t last_smb_conf_reload_time;
63 extern time_t last_printer_reload_time;
64 extern pid_t background_lpq_updater_pid;
66 /****************************************************************************
67 structure to hold a linked list of queued messages.
68 for processing.
69 ****************************************************************************/
70 extern uint32_t common_flags2;
72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
75 struct sec_ctx {
76 struct security_unix_token ut;
77 struct security_token *token;
79 /* A stack of security contexts. We include the current context as being
80 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
81 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
82 extern int sec_ctx_stack_ndx;
83 extern bool become_uid_done;
84 extern bool become_gid_done;
86 extern connection_struct *last_conn;
87 extern uint16_t last_flags;
89 extern uint32_t global_client_caps;
91 extern uint16_t fnf_handle;
93 struct conn_ctx {
94 connection_struct *conn;
95 uint64_t vuid;
97 /* A stack of current_user connection contexts. */
98 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
99 extern int conn_ctx_stack_ndx;
101 struct vfs_init_function_entry;
102 extern struct vfs_init_function_entry *backends;
103 extern char *sparse_buf;
104 extern char *LastDir;
106 struct smbd_parent_context;
107 extern struct smbd_parent_context *am_parent;
108 extern struct memcache *smbd_memcache_ctx;
109 extern bool exit_firsttime;
111 struct tstream_context;
112 struct smbd_smb2_request;
114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
116 void smbd_lock_socket(struct smbd_server_connection *sconn);
117 void smbd_unlock_socket(struct smbd_server_connection *sconn);
119 NTSTATUS smbd_do_locking(struct smb_request *req,
120 files_struct *fsp,
121 uint8_t type,
122 int32_t timeout,
123 uint16_t num_ulocks,
124 struct smbd_lock_element *ulocks,
125 uint16_t num_locks,
126 struct smbd_lock_element *locks,
127 bool *async);
129 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
130 TALLOC_CTX *mem_ctx,
131 uint16_t info_level,
132 files_struct *fsp,
133 struct smb_filename *smb_fname,
134 bool delete_pending,
135 struct timespec write_time_ts,
136 struct ea_list *ea_list,
137 int lock_data_count,
138 char *lock_data,
139 uint16_t flags2,
140 unsigned int max_data_bytes,
141 char **ppdata,
142 unsigned int *pdata_size);
144 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
145 struct smb_request *req,
146 TALLOC_CTX *mem_ctx,
147 uint16_t info_level,
148 files_struct *fsp,
149 struct smb_filename *smb_fname,
150 char **ppdata, int total_data,
151 int *ret_data_size);
153 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
154 TALLOC_CTX *mem_ctx,
155 uint16_t info_level,
156 uint16_t flags2,
157 unsigned int max_data_bytes,
158 char **ppdata,
159 int *ret_data_len);
161 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
162 struct dptr_struct *dirptr,
163 const char *mask,
164 uint32_t dirtype,
165 bool dont_descend,
166 bool ask_sharemode,
167 bool (*match_fn)(TALLOC_CTX *ctx,
168 void *private_data,
169 const char *dname,
170 const char *mask,
171 char **_fname),
172 bool (*mode_fn)(TALLOC_CTX *ctx,
173 void *private_data,
174 struct smb_filename *smb_fname,
175 uint32_t *_mode),
176 void *private_data,
177 char **_fname,
178 struct smb_filename **_smb_fname,
179 uint32_t *_mode,
180 long *_prev_offset);
182 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
183 connection_struct *conn,
184 struct dptr_struct *dirptr,
185 uint16 flags2,
186 const char *path_mask,
187 uint32 dirtype,
188 int info_level,
189 int requires_resume_key,
190 bool dont_descend,
191 bool ask_sharemode,
192 uint8_t align,
193 bool do_pad,
194 char **ppdata,
195 char *base_data,
196 char *end_data,
197 int space_remaining,
198 bool *out_of_space,
199 bool *got_exact_match,
200 int *_last_entry_off,
201 struct ea_list *name_list);
203 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
204 const struct smb_filename *smb_fname,
205 bool use_privs,
206 uint32_t access_mask,
207 uint32_t *access_mask_out);
209 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
211 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
212 const char *reason,
213 const char *location);
214 #define smbd_server_connection_terminate(sconn, reason) \
215 smbd_server_connection_terminate_ex(sconn, reason, __location__)
217 const char *smb2_opcode_name(uint16_t opcode);
218 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
220 void reply_smb2002(struct smb_request *req, uint16_t choice);
221 void reply_smb20ff(struct smb_request *req, uint16_t choice);
222 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
223 uint8_t *inbuf, size_t size);
225 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
226 NTSTATUS status,
227 DATA_BLOB *info,
228 const char *location);
229 #define smbd_smb2_request_error(req, status) \
230 smbd_smb2_request_error_ex(req, status, NULL, __location__)
231 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
232 NTSTATUS status,
233 DATA_BLOB body, DATA_BLOB *dyn,
234 const char *location);
235 #define smbd_smb2_request_done(req, body, dyn) \
236 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
238 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
239 struct smbXsrv_session *session,
240 struct smbXsrv_tcon *tcon,
241 struct smbXsrv_open *op,
242 uint8_t oplock_level);
244 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
245 struct tevent_req *subreq,
246 uint32_t defer_time);
248 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
249 void remove_smb2_chained_fsp(files_struct *fsp);
251 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
252 uint32_t data_length);
254 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
255 size_t expected_body_size);
257 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
258 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
259 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
260 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
261 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
262 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
263 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
264 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
265 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
266 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
267 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
268 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
269 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
270 int err);
271 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
272 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
273 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
274 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
275 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
276 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
277 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
278 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
279 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
280 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
281 struct tevent_immediate *im,
282 void *private_data);
284 /* SMB1 -> SMB2 glue. */
285 void send_break_message_smb2(files_struct *fsp, int level);
286 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
287 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
288 struct smb_request *req,
289 files_struct *fsp,
290 int lock_timeout,
291 int lock_num,
292 uint64_t smblctx,
293 enum brl_type lock_type,
294 enum brl_flavour lock_flav,
295 uint64_t offset,
296 uint64_t count,
297 uint64_t blocking_smblctx);
298 void process_blocking_lock_queue_smb2(
299 struct smbd_server_connection *sconn, struct timeval tv_curr);
300 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
301 struct byte_range_lock *br_lck,
302 enum file_close_type close_type);
303 /* From smbd/smb2_create.c */
304 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
305 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
306 struct timeval *p_request_time,
307 void **pp_state);
308 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
309 uint64_t mid);
310 void remove_deferred_open_message_smb2(
311 struct smbd_server_connection *sconn, uint64_t mid);
312 bool schedule_deferred_open_message_smb2(
313 struct smbd_server_connection *sconn, uint64_t mid);
314 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
315 struct timeval request_time,
316 struct timeval timeout,
317 struct file_id id,
318 char *private_data,
319 size_t priv_len);
321 struct smbXsrv_connection {
322 struct smbd_server_connection *sconn;
324 const struct tsocket_address *local_address;
325 const struct tsocket_address *remote_address;
326 const char *remote_hostname;
328 struct tevent_context *ev_ctx;
329 struct messaging_context *msg_ctx;
331 enum protocol_types protocol;
333 struct {
334 struct {
335 uint32_t capabilities;
336 struct GUID guid;
337 uint16_t security_mode;
338 uint16_t num_dialects;
339 uint16_t *dialects;
340 } client;
341 struct {
342 uint32_t capabilities;
343 struct GUID guid;
344 uint16_t security_mode;
345 uint16_t dialect;
346 uint32_t max_trans;
347 uint32_t max_read;
348 uint32_t max_write;
349 } server;
350 } smb2;
352 struct msg_state *msg_state;
355 * Link into libasys for asynchronous operations
357 struct asys_context *asys_ctx;
358 struct tevent_fd *asys_fde;
360 uint64_t smbd_idle_profstamp;
363 * this session_table is used for SMB1 and SMB2,
365 struct smbXsrv_session_table *session_table;
367 * this tcon_table is only used for SMB1.
369 struct smbXsrv_tcon_table *tcon_table;
371 * this open_table is used for SMB1 and SMB2,
372 * because we have a global sconn->real_max_open_files
373 * limit.
375 struct smbXsrv_open_table *open_table;
378 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
379 uint32_t smbXsrv_version_global_current(void);
381 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
382 enum protocol_types protocol);
384 NTSTATUS smbXsrv_session_global_init(void);
385 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
386 NTTIME now,
387 struct smbXsrv_session **_session);
388 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
389 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
390 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
391 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
392 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
393 uint16_t vuid, NTTIME now,
394 struct smbXsrv_session **session);
395 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
396 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
397 uint64_t session_id, NTTIME now,
398 struct smbXsrv_session **session);
399 struct smbXsrv_session_global0;
400 NTSTATUS smbXsrv_session_global_traverse(
401 int (*fn)(struct smbXsrv_session_global0 *, void *),
402 void *private_data);
403 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
404 struct tevent_context *ev,
405 struct smbXsrv_connection *conn,
406 struct auth_session_info *session_info,
407 uint64_t previous_session_id,
408 uint64_t current_session_id);
409 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
411 NTSTATUS smbXsrv_tcon_global_init(void);
412 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
413 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
414 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
415 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
416 NTTIME now,
417 struct smbXsrv_tcon **_tcon);
418 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
419 uint16_t tree_id, NTTIME now,
420 struct smbXsrv_tcon **tcon);
421 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
422 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
423 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
424 NTTIME now,
425 struct smbXsrv_tcon **_tcon);
426 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
427 uint32_t tree_id, NTTIME now,
428 struct smbXsrv_tcon **tcon);
429 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
430 struct smbXsrv_tcon_global0;
431 NTSTATUS smbXsrv_tcon_global_traverse(
432 int (*fn)(struct smbXsrv_tcon_global0 *, void *),
433 void *private_data);
435 NTSTATUS smbXsrv_open_global_init(void);
436 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
437 struct auth_session_info *session_info,
438 NTTIME now,
439 struct smbXsrv_open **_open);
440 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
441 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
442 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
443 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
444 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
445 uint16_t fnum, NTTIME now,
446 struct smbXsrv_open **_open);
447 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
448 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
449 uint64_t persistent_id,
450 uint64_t volatile_id,
451 NTTIME now,
452 struct smbXsrv_open **_open);
453 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
454 struct auth_session_info *session_info,
455 uint64_t persistent_id,
456 struct GUID create_guid,
457 NTTIME now,
458 struct smbXsrv_open **_open);
460 struct smbd_smb2_request {
461 struct smbd_smb2_request *prev, *next;
463 struct smbd_server_connection *sconn;
465 /* the session the request operates on, maybe NULL */
466 struct smbXsrv_session *session;
467 uint64_t last_session_id;
469 /* the tcon the request operates on, maybe NULL */
470 struct smbXsrv_tcon *tcon;
471 uint32_t last_tid;
473 int current_idx;
474 bool do_signing;
475 bool do_encryption;
476 struct tevent_timer *async_te;
477 bool compound_related;
480 * the encryption key for the whole
481 * compound chain
483 DATA_BLOB first_key;
485 * the signing key for the last
486 * request/response of a compound chain
488 DATA_BLOB last_key;
490 struct timeval request_time;
492 /* fake smb1 request. */
493 struct smb_request *smb1req;
494 struct files_struct *compat_chain_fsp;
497 * The sub request for async backend calls.
498 * This is used for SMB2 Cancel.
500 struct tevent_req *subreq;
502 #define SMBD_SMB2_TF_IOV_OFS 0
503 #define SMBD_SMB2_HDR_IOV_OFS 1
504 #define SMBD_SMB2_BODY_IOV_OFS 2
505 #define SMBD_SMB2_DYN_IOV_OFS 3
507 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
509 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
510 (&req->dir.vector[(idx)+(ofs)])
512 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
513 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
514 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
515 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
516 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
517 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
518 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
519 SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
521 #define SMBD_SMB2_IN_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
522 #define SMBD_SMB2_IN_TF_PTR(req) (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
523 #define SMBD_SMB2_IN_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
524 #define SMBD_SMB2_IN_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
525 #define SMBD_SMB2_IN_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
526 #define SMBD_SMB2_IN_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
527 #define SMBD_SMB2_IN_BODY_LEN(req) (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
528 #define SMBD_SMB2_IN_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
529 #define SMBD_SMB2_IN_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
530 #define SMBD_SMB2_IN_DYN_LEN(req) (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
532 #define SMBD_SMB2_OUT_TF_IOV(req) SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
533 #define SMBD_SMB2_OUT_TF_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
534 #define SMBD_SMB2_OUT_HDR_IOV(req) SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
535 #define SMBD_SMB2_OUT_HDR_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
536 #define SMBD_SMB2_OUT_BODY_IOV(req) SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
537 #define SMBD_SMB2_OUT_BODY_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
538 #define SMBD_SMB2_OUT_BODY_LEN(req) (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
539 #define SMBD_SMB2_OUT_DYN_IOV(req) SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
540 #define SMBD_SMB2_OUT_DYN_PTR(req) (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
541 #define SMBD_SMB2_OUT_DYN_LEN(req) (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
543 struct {
545 * vector[0] TRANSPORT HEADER (empty)
547 * vector[1] SMB2_TRANSFORM (optional)
548 * vector[2] SMB2
549 * vector[3] fixed body
550 * vector[4] dynamic body
554 * vector[5] SMB2_TRANSFORM (optional)
555 * vector[6] SMB2
556 * vector[7] fixed body
557 * vector[8] dynamic body
562 struct iovec *vector;
563 int vector_count;
564 } in;
565 struct {
566 /* the NBT header is not allocated */
567 uint8_t nbt_hdr[4];
569 * vector[0] TRANSPORT HEADER
571 * vector[1] SMB2_TRANSFORM (optional)
572 * vector[2] SMB2
573 * vector[3] fixed body
574 * vector[4] dynamic body
578 * vector[5] SMB2_TRANSFORM (empty)
579 * vector[6] SMB2
580 * vector[7] fixed body
581 * vector[8] dynamic body
586 struct iovec *vector;
587 int vector_count;
588 } out;
591 struct smbd_server_connection;
592 struct user_struct;
594 struct pending_message_list;
595 struct pending_auth_data;
597 struct user_struct {
598 struct user_struct *next, *prev;
599 uint64_t vuid; /* Tag for this entry. */
601 char *session_keystr; /* used by utmp and pam session code.
602 TDB key string */
603 int homes_snum;
605 struct auth_session_info *session_info;
607 struct smbXsrv_session *session;
610 struct smbd_server_connection {
611 int sock;
612 const struct tsocket_address *local_address;
613 const struct tsocket_address *remote_address;
614 const char *remote_hostname;
615 struct tevent_context *ev_ctx;
616 struct messaging_context *msg_ctx;
617 struct sys_notify_context *sys_notify_ctx;
618 struct notify_context *notify_ctx;
619 struct {
620 bool got_session;
621 } nbt;
622 bool using_smb2;
623 int trans_num;
625 size_t num_users;
626 struct user_struct *users;
628 size_t num_connections;
629 struct connection_struct *connections;
631 size_t num_files;
632 struct files_struct *files;
634 int real_max_open_files;
635 struct fsp_singleton_cache fsp_fi_cache;
637 struct pending_message_list *deferred_open_queue;
640 /* open directory handles. */
641 struct {
642 struct bitmap *dptr_bmap;
643 struct dptr_struct *dirptrs;
644 int dirhandles_open;
645 } searches;
647 uint64_t num_requests;
649 /* Current number of oplocks we have outstanding. */
650 struct {
651 int32_t exclusive_open;
652 int32_t level_II_open;
653 struct kernel_oplocks *kernel_ops;
654 } oplocks;
656 struct {
657 struct fd_event *fde;
659 struct {
661 * fd for the fcntl lock mutexing access to our sock
663 int socket_lock_fd;
666 * fd for the trusted pipe from
667 * echo handler child
669 int trusted_fd;
672 * fde for the trusted_fd
674 struct fd_event *trusted_fde;
677 * Reference count for the fcntl lock to
678 * allow recursive locks.
680 int ref_count;
681 } echo_handler;
683 struct {
684 bool encrypted_passwords;
685 bool spnego;
686 struct auth4_context *auth_context;
687 bool done;
689 * Size of the data we can receive. Set by us.
690 * Can be modified by the max xmit parameter.
692 int max_recv;
693 } negprot;
695 struct {
696 uint16_t client_major;
697 uint16_t client_minor;
698 uint32_t client_cap_low;
699 uint32_t client_cap_high;
700 } unix_info;
702 struct {
703 bool done_sesssetup;
705 * Size of data we can send to client. Set
706 * by the client for all protocols above CORE.
707 * Set by us for CORE protocol.
709 int max_send;
710 uint64_t last_session_tag;
711 } sessions;
712 struct smb_signing_state *signing_state;
714 struct notify_mid_map *notify_mid_maps;
716 struct {
717 /* dlink list we store pending lock records on. */
718 struct blocking_lock_record *blocking_lock_queue;
719 /* dlink list we move cancelled lock records onto. */
720 struct blocking_lock_record *blocking_lock_cancelled_queue;
722 /* The event that makes us process our blocking lock queue */
723 struct timed_event *brl_timeout;
725 bool blocking_lock_unlock_state;
726 bool blocking_lock_cancel_state;
727 } locks;
728 } smb1;
729 struct {
730 struct tevent_queue *recv_queue;
731 struct tevent_queue *send_queue;
732 struct tstream_context *stream;
733 bool negprot_2ff;
734 struct {
735 /* The event that makes us process our blocking lock queue */
736 struct timed_event *brl_timeout;
737 bool blocking_lock_unlock_state;
738 } locks;
739 struct smbd_smb2_request *requests;
741 * seqnum_low is the lowest sequence number
742 * we will accept.
744 uint64_t seqnum_low;
746 * seqnum_range is the range of credits we have
747 * granted from the sequence windows starting
748 * at seqnum_low.
750 * This gets incremented when new credits are
751 * granted and gets decremented when the
752 * lowest sequence number is consumed
753 * (when seqnum_low gets incremented).
755 uint16_t seqnum_range;
757 * credits_grantedThe number of credits we have currently granted
758 * to the client.
760 * This gets incremented when new credits are
761 * granted and gets decremented when any credit
762 * is comsumed.
764 * Note: the decrementing is different compared
765 * to seqnum_range.
767 uint16_t credits_granted;
769 * The maximum number of credits we will ever
770 * grant to the client.
772 * Typically we will only grant 1/16th of
773 * max_credits.
775 * This is the "server max credits" parameter.
777 uint16_t max_credits;
779 * a bitmap of size max_credits
781 struct bitmap *credits_bitmap;
782 bool supports_multicredit;
783 uint32_t max_trans;
784 uint32_t max_read;
785 uint32_t max_write;
786 bool compound_related_in_progress;
787 } smb2;
789 struct smbXsrv_connection *conn;
792 extern struct smbXsrv_connection *global_smbXsrv_connection;
794 void smbd_init_globals(void);