s3:smbd: add support for SMB2 Keepalive (SMB2 Echo)
[ira/wip.git] / source3 / smbd / globals.h
1 /*
2    Unix SMB/Netbios implementation.
3    smbd globals
4    Copyright (C) Stefan Metzmacher 2009
5
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.
10
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.
15
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/>.
18 */
19
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
27
28 /* dlink list we store pending lock records on. */
29 extern struct blocking_lock_record *blocking_lock_queue;
30
31 /* dlink list we move cancelled lock records onto. */
32 extern struct blocking_lock_record *blocking_lock_cancelled_queue;
33
34 /* The event that makes us process our blocking lock queue */
35 extern struct timed_event *brl_timeout;
36
37 extern bool blocking_lock_unlock_state;
38 extern bool blocking_lock_cancel_state;
39
40 #ifdef USE_DMAPI
41 struct smbd_dmapi_context;
42 extern struct smbd_dmapi_context *dmapi_ctx;
43 #endif
44
45 extern connection_struct *Connections;
46 /* number of open connections */
47 extern struct bitmap *bmap;
48 extern int num_open;
49
50 extern bool dfree_broken;
51
52 extern struct bitmap *dptr_bmap;
53 //struct dptr_struct;
54 extern struct dptr_struct *dirptrs;
55 extern int dirhandles_open;
56
57 /* how many write cache buffers have been allocated */
58 extern unsigned int allocated_write_caches;
59
60 extern int real_max_open_files;
61 extern struct bitmap *file_bmap;
62 extern files_struct *Files;
63 extern int files_used;
64 /* A singleton cache to speed up searching by dev/inode. */
65 struct fsp_singleton_cache {
66         files_struct *fsp;
67         struct file_id id;
68 };
69 extern struct fsp_singleton_cache fsp_fi_cache;
70 extern unsigned long file_gen_counter;
71 extern int first_file;
72
73 extern const struct mangle_fns *mangle_fns;
74
75 extern unsigned char *chartest;
76 extern TDB_CONTEXT *tdb_mangled_cache;
77
78 /* these tables are used to provide fast tests for characters */
79 extern unsigned char char_flags[256];
80 /*
81   this determines how many characters are used from the original filename
82   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
83   The largest possible value is 6.
84 */
85 extern unsigned mangle_prefix;
86 extern unsigned char base_reverse[256];
87
88 extern char *last_from;
89 extern char *last_to;
90
91 struct msg_state;
92 extern struct msg_state *smbd_msg_state;
93
94 extern bool global_encrypted_passwords_negotiated;
95 extern bool global_spnego_negotiated;
96 extern struct auth_context *negprot_global_auth_context;
97 extern bool done_negprot;
98
99 extern bool logged_ioctl_message;
100
101 /* users from session setup */
102 extern char *session_userlist;
103 /* workgroup from session setup. */
104 extern char *session_workgroup;
105 /* this holds info on user ids that are already validated for this VC */
106 extern user_struct *validated_users;
107 extern uint16_t next_vuid;
108 extern int num_validated_vuids;
109 #ifdef HAVE_NETGROUP
110 extern char *my_yp_domain;
111 #endif
112
113 extern bool already_got_session;
114
115 /*
116  * Size of data we can send to client. Set
117  *  by the client for all protocols above CORE.
118  *  Set by us for CORE protocol.
119  */
120 extern int max_send;
121 /*
122  * Size of the data we can receive. Set by us.
123  * Can be modified by the max xmit parameter.
124  */
125 extern int max_recv;
126 extern uint16 last_session_tag;
127 extern int trans_num;
128 extern char *orig_inbuf;
129
130 extern pid_t mypid;
131 extern time_t last_smb_conf_reload_time;
132 extern time_t last_printer_reload_time;
133 /****************************************************************************
134  structure to hold a linked list of queued messages.
135  for processing.
136 ****************************************************************************/
137 struct pending_message_list;
138 extern struct pending_message_list *deferred_open_queue;
139 extern uint32_t common_flags2;
140
141 struct smb_srv_trans_enc_ctx;
142 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
143 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
144
145 struct sec_ctx {
146         UNIX_USER_TOKEN ut;
147         NT_USER_TOKEN *token;
148 };
149 /* A stack of security contexts.  We include the current context as being
150    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
151 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
152 extern int sec_ctx_stack_ndx;
153 extern bool become_uid_done;
154 extern bool become_gid_done;
155
156 extern connection_struct *last_conn;
157 extern uint16_t last_flags;
158
159 extern struct db_context *session_db_ctx_ptr;
160
161 extern uint32_t global_client_caps;
162 extern bool done_sesssetup;
163 /****************************************************************************
164  List to store partial SPNEGO auth fragments.
165 ****************************************************************************/
166 struct pending_auth_data;
167 extern struct pending_auth_data *pd_list;
168
169 extern uint16_t fnf_handle;
170
171 struct conn_ctx {
172         connection_struct *conn;
173         uint16 vuid;
174 };
175 /* A stack of current_user connection contexts. */
176 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
177 extern int conn_ctx_stack_ndx;
178
179 struct vfs_init_function_entry;
180 extern struct vfs_init_function_entry *backends;
181 extern char *sparse_buf;
182 extern char *LastDir;
183
184 /* Current number of oplocks we have outstanding. */
185 extern int32_t exclusive_oplocks_open;
186 extern int32_t level_II_oplocks_open;
187 extern bool global_client_failed_oplock_break;
188 extern struct kernel_oplocks *koplocks;
189
190 extern struct notify_mid_map *notify_changes_by_mid;
191
192 extern int am_parent;
193 extern int server_fd;
194 extern struct event_context *smbd_event_ctx;
195 extern struct messaging_context *smbd_msg_ctx;
196 extern struct memcache *smbd_memcache_ctx;
197 extern bool exit_firsttime;
198 struct child_pid;
199 extern struct child_pid *children;
200 extern int num_children;
201
202 struct tstream_context;
203 struct smbd_smb2_request;
204
205 DATA_BLOB negprot_spnego(void);
206
207 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
208
209 void reply_smb2002(struct smb_request *req, uint16_t choice);
210 void smbd_smb2_first_negprot(struct smbd_server_connection *conn,
211                              const uint8_t *inbuf, size_t size);
212
213 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
214                                     NTSTATUS status, DATA_BLOB *info);
215 NTSTATUS smbd_smb2_request_error(struct smbd_smb2_request *req,
216                                  NTSTATUS status);
217 NTSTATUS smbd_smb2_request_done(struct smbd_smb2_request *req,
218                                 DATA_BLOB body, DATA_BLOB *dyn);
219
220 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
221 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
222
223 struct smbd_smb2_request {
224         TALLOC_CTX *mem_pool;
225
226         struct smbd_server_connection *conn;
227
228         int current_idx;
229
230         struct {
231                 /* the NBT header is not allocated */
232                 uint8_t nbt_hdr[4];
233                 /*
234                  * vector[0] NBT
235                  * .
236                  * vector[1] SMB2
237                  * vector[2] fixed body
238                  * vector[3] dynamic body
239                  * .
240                  * .
241                  * .
242                  * vector[4] SMB2
243                  * vector[5] fixed body
244                  * vector[6] dynamic body
245                  * .
246                  * .
247                  * .
248                  */
249                 struct iovec *vector;
250                 int vector_count;
251         } in;
252         struct {
253                 /* the NBT header is not allocated */
254                 uint8_t nbt_hdr[4];
255                 /*
256                  * vector[0] NBT
257                  * .
258                  * vector[1] SMB2
259                  * vector[2] fixed body
260                  * vector[3] dynamic body
261                  * .
262                  * .
263                  * .
264                  * vector[4] SMB2
265                  * vector[5] fixed body
266                  * vector[6] dynamic body
267                  * .
268                  * .
269                  * .
270                  */
271                 struct iovec *vector;
272                 int vector_count;
273         } out;
274 };
275
276 struct smbd_server_connection {
277         struct fd_event *fde;
278         uint64_t num_requests;
279         struct smb_signing_state *signing_state;
280         bool allow_smb2;
281         struct {
282                 struct tevent_context *event_ctx;
283                 struct tevent_queue *recv_queue;
284                 struct tevent_queue *send_queue;
285                 struct tstream_context *stream;
286         } smb2;
287 };
288
289 extern struct smbd_server_connection *smbd_server_conn;
290
291 void smbd_init_globals(void);