s3/docs: Fix typo.
[Samba/gebeck_regimport.git] / source3 / smbd / globals.h
blobf002a6f51aa0e46d1b7692fca67ba0a29655620f
1 /*
2 Unix SMB/Netbios implementation.
3 smbd globals
4 Copyright (C) Stefan Metzmacher 2009
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #if defined(WITH_AIO)
21 struct aio_extra;
22 extern struct aio_extra *aio_list_head;
23 extern struct tevent_signal *aio_signal_event;
24 extern int aio_pending_size;
25 extern int outstanding_aio_calls;
26 #endif
28 /* dlink list we store pending lock records on. */
29 extern struct blocking_lock_record *blocking_lock_queue;
31 /* dlink list we move cancelled lock records onto. */
32 extern struct blocking_lock_record *blocking_lock_cancelled_queue;
34 /* The event that makes us process our blocking lock queue */
35 extern struct timed_event *brl_timeout;
37 extern bool blocking_lock_unlock_state;
38 extern bool blocking_lock_cancel_state;
40 #ifdef USE_DMAPI
41 struct smbd_dmapi_context;
42 extern struct smbd_dmapi_context *dmapi_ctx;
43 #endif
45 extern bool dfree_broken;
47 extern struct bitmap *dptr_bmap;
48 //struct dptr_struct;
49 extern struct dptr_struct *dirptrs;
50 extern int dirhandles_open;
52 /* how many write cache buffers have been allocated */
53 extern unsigned int allocated_write_caches;
55 extern int real_max_open_files;
56 extern struct bitmap *file_bmap;
57 extern files_struct *Files;
58 extern int files_used;
59 /* A singleton cache to speed up searching by dev/inode. */
60 struct fsp_singleton_cache {
61 files_struct *fsp;
62 struct file_id id;
64 extern struct fsp_singleton_cache fsp_fi_cache;
65 extern unsigned long file_gen_counter;
66 extern int first_file;
68 extern const struct mangle_fns *mangle_fns;
70 extern unsigned char *chartest;
71 extern TDB_CONTEXT *tdb_mangled_cache;
73 /* these tables are used to provide fast tests for characters */
74 extern unsigned char char_flags[256];
76 this determines how many characters are used from the original filename
77 in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
78 The largest possible value is 6.
80 extern unsigned mangle_prefix;
81 extern unsigned char base_reverse[256];
83 extern char *last_from;
84 extern char *last_to;
86 struct msg_state;
87 extern struct msg_state *smbd_msg_state;
89 extern bool logged_ioctl_message;
91 extern int trans_num;
93 extern pid_t mypid;
94 extern time_t last_smb_conf_reload_time;
95 extern time_t last_printer_reload_time;
96 /****************************************************************************
97 structure to hold a linked list of queued messages.
98 for processing.
99 ****************************************************************************/
100 struct pending_message_list;
101 extern struct pending_message_list *deferred_open_queue;
102 extern uint32_t common_flags2;
104 struct smb_srv_trans_enc_ctx;
105 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
106 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
108 struct sec_ctx {
109 UNIX_USER_TOKEN ut;
110 NT_USER_TOKEN *token;
112 /* A stack of security contexts. We include the current context as being
113 the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
114 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
115 extern int sec_ctx_stack_ndx;
116 extern bool become_uid_done;
117 extern bool become_gid_done;
119 extern connection_struct *last_conn;
120 extern uint16_t last_flags;
122 extern struct db_context *session_db_ctx_ptr;
124 extern uint32_t global_client_caps;
126 extern uint16_t fnf_handle;
128 struct conn_ctx {
129 connection_struct *conn;
130 uint16 vuid;
132 /* A stack of current_user connection contexts. */
133 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
134 extern int conn_ctx_stack_ndx;
136 struct vfs_init_function_entry;
137 extern struct vfs_init_function_entry *backends;
138 extern char *sparse_buf;
139 extern char *LastDir;
141 /* Current number of oplocks we have outstanding. */
142 extern int32_t exclusive_oplocks_open;
143 extern int32_t level_II_oplocks_open;
144 extern bool global_client_failed_oplock_break;
145 extern struct kernel_oplocks *koplocks;
147 extern struct notify_mid_map *notify_changes_by_mid;
149 extern int am_parent;
150 extern int server_fd;
151 extern struct event_context *smbd_event_ctx;
152 extern struct messaging_context *smbd_msg_ctx;
153 extern struct memcache *smbd_memcache_ctx;
154 extern bool exit_firsttime;
155 struct child_pid;
156 extern struct child_pid *children;
157 extern int num_children;
159 struct tstream_context;
160 struct smbd_smb2_request;
161 struct smbd_smb2_session;
162 struct smbd_smb2_tcon;
164 DATA_BLOB negprot_spnego(void);
166 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
167 struct iovec *vector,
168 int count);
169 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
170 const struct iovec *vector,
171 int count);
173 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
174 const char *reason,
175 const char *location);
176 #define smbd_server_connection_terminate(sconn, reason) \
177 smbd_server_connection_terminate_ex(sconn, reason, __location__)
179 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
181 void reply_smb2002(struct smb_request *req, uint16_t choice);
182 void smbd_smb2_first_negprot(struct smbd_server_connection *conn,
183 const uint8_t *inbuf, size_t size);
185 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
186 NTSTATUS status,
187 DATA_BLOB *info,
188 const char *location);
189 #define smbd_smb2_request_error(req, status) \
190 smbd_smb2_request_error_ex(req, status, NULL, __location__)
191 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
192 NTSTATUS status,
193 DATA_BLOB body, DATA_BLOB *dyn,
194 const char *location);
195 #define smbd_smb2_request_done(req, body, dyn) \
196 smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
198 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
199 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
201 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
203 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
204 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
205 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
206 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
207 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
208 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
209 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
210 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
211 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
212 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
213 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
214 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
216 struct smbd_smb2_request {
217 TALLOC_CTX *mem_pool;
219 struct smbd_server_connection *conn;
221 /* the session the request operates on, maybe NULL */
222 struct smbd_smb2_session *session;
224 /* the tcon the request operates on, maybe NULL */
225 struct smbd_smb2_tcon *tcon;
227 int current_idx;
228 bool do_signing;
230 struct files_struct *compat_chain_fsp;
232 NTSTATUS next_status;
234 struct {
235 /* the NBT header is not allocated */
236 uint8_t nbt_hdr[4];
238 * vector[0] NBT
240 * vector[1] SMB2
241 * vector[2] fixed body
242 * vector[3] dynamic body
246 * vector[4] SMB2
247 * vector[5] fixed body
248 * vector[6] dynamic body
253 struct iovec *vector;
254 int vector_count;
255 } in;
256 struct {
257 /* the NBT header is not allocated */
258 uint8_t nbt_hdr[4];
260 * vector[0] NBT
262 * vector[1] SMB2
263 * vector[2] fixed body
264 * vector[3] dynamic body
268 * vector[4] SMB2
269 * vector[5] fixed body
270 * vector[6] dynamic body
275 struct iovec *vector;
276 int vector_count;
277 } out;
280 struct smbd_server_connection;
282 struct smbd_smb2_session {
283 struct smbd_smb2_session *prev, *next;
284 struct smbd_server_connection *conn;
285 NTSTATUS status;
286 uint64_t vuid;
287 AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
288 struct auth_serversupplied_info *server_info;
289 DATA_BLOB session_key;
290 bool do_signing;
292 user_struct *compat_vuser;
294 struct {
295 /* an id tree used to allocate tids */
296 struct idr_context *idtree;
298 /* this is the limit of tid values for this connection */
299 uint32_t limit;
301 struct smbd_smb2_tcon *list;
302 } tcons;
305 struct smbd_smb2_tcon {
306 struct smbd_smb2_tcon *prev, *next;
307 struct smbd_smb2_session *session;
308 uint32_t tid;
309 int snum;
310 connection_struct *compat_conn;
313 struct pending_auth_data;
315 struct smbd_server_connection {
316 struct {
317 bool got_session;
318 } nbt;
319 bool allow_smb2;
320 struct {
321 struct fd_event *fde;
322 uint64_t num_requests;
323 struct {
324 bool encrypted_passwords;
325 bool spnego;
326 struct auth_context *auth_context;
327 bool done;
329 * Size of the data we can receive. Set by us.
330 * Can be modified by the max xmit parameter.
332 int max_recv;
333 } negprot;
335 struct {
336 bool done_sesssetup;
338 * Size of data we can send to client. Set
339 * by the client for all protocols above CORE.
340 * Set by us for CORE protocol.
342 int max_send;
343 uint16_t last_session_tag;
345 /* users from session setup */
346 char *session_userlist;
347 /* workgroup from session setup. */
348 char *session_workgroup;
350 * this holds info on user ids that are already
351 * validated for this VC
353 user_struct *validated_users;
354 uint16_t next_vuid;
355 int num_validated_vuids;
356 #ifdef HAVE_NETGROUP
357 char *my_yp_domain;
358 #endif
359 } sessions;
360 struct {
361 connection_struct *Connections;
362 /* number of open connections */
363 struct bitmap *bmap;
364 int num_open;
365 } tcons;
366 struct smb_signing_state *signing_state;
367 /* List to store partial SPNEGO auth fragments. */
368 struct pending_auth_data *pd_list;
369 } smb1;
370 struct {
371 struct tevent_context *event_ctx;
372 struct tevent_queue *recv_queue;
373 struct tevent_queue *send_queue;
374 struct tstream_context *stream;
375 struct {
376 /* an id tree used to allocate vuids */
377 /* this holds info on session vuids that are already
378 * validated for this VC */
379 struct idr_context *idtree;
381 /* this is the limit of vuid values for this connection */
382 uint64_t limit;
384 struct smbd_smb2_session *list;
385 } sessions;
386 } smb2;
389 extern struct smbd_server_connection *smbd_server_conn;
391 void smbd_init_globals(void);