3cc967f4fd3164bb4ae8599e4b01307a14a66f8e
[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 bool dfree_broken;
46
47 /* how many write cache buffers have been allocated */
48 extern unsigned int allocated_write_caches;
49
50 extern int real_max_open_files;
51 extern struct bitmap *file_bmap;
52 extern files_struct *Files;
53 extern int files_used;
54 /* A singleton cache to speed up searching by dev/inode. */
55 struct fsp_singleton_cache {
56         files_struct *fsp;
57         struct file_id id;
58 };
59 extern struct fsp_singleton_cache fsp_fi_cache;
60 extern unsigned long file_gen_counter;
61 extern int first_file;
62
63 extern const struct mangle_fns *mangle_fns;
64
65 extern unsigned char *chartest;
66 extern TDB_CONTEXT *tdb_mangled_cache;
67
68 /* these tables are used to provide fast tests for characters */
69 extern unsigned char char_flags[256];
70 /*
71   this determines how many characters are used from the original filename
72   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
73   The largest possible value is 6.
74 */
75 extern unsigned mangle_prefix;
76 extern unsigned char base_reverse[256];
77
78 extern char *last_from;
79 extern char *last_to;
80
81 struct msg_state;
82 extern struct msg_state *smbd_msg_state;
83
84 extern bool logged_ioctl_message;
85
86 extern int trans_num;
87
88 extern pid_t mypid;
89 extern time_t last_smb_conf_reload_time;
90 extern time_t last_printer_reload_time;
91 /****************************************************************************
92  structure to hold a linked list of queued messages.
93  for processing.
94 ****************************************************************************/
95 struct pending_message_list;
96 extern struct pending_message_list *deferred_open_queue;
97 extern uint32_t common_flags2;
98
99 struct smb_srv_trans_enc_ctx;
100 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
101 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
102
103 struct sec_ctx {
104         UNIX_USER_TOKEN ut;
105         NT_USER_TOKEN *token;
106 };
107 /* A stack of security contexts.  We include the current context as being
108    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
109 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
110 extern int sec_ctx_stack_ndx;
111 extern bool become_uid_done;
112 extern bool become_gid_done;
113
114 extern connection_struct *last_conn;
115 extern uint16_t last_flags;
116
117 extern struct db_context *session_db_ctx_ptr;
118
119 extern uint32_t global_client_caps;
120
121 extern uint16_t fnf_handle;
122
123 struct conn_ctx {
124         connection_struct *conn;
125         uint16 vuid;
126 };
127 /* A stack of current_user connection contexts. */
128 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
129 extern int conn_ctx_stack_ndx;
130
131 struct vfs_init_function_entry;
132 extern struct vfs_init_function_entry *backends;
133 extern char *sparse_buf;
134
135 /* Current number of oplocks we have outstanding. */
136 extern int32_t exclusive_oplocks_open;
137 extern int32_t level_II_oplocks_open;
138 extern bool global_client_failed_oplock_break;
139 extern struct kernel_oplocks *koplocks;
140
141 extern int am_parent;
142 extern int server_fd;
143 extern struct event_context *smbd_event_ctx;
144 extern struct messaging_context *smbd_msg_ctx;
145 extern struct memcache *smbd_memcache_ctx;
146 extern bool exit_firsttime;
147 struct child_pid;
148 extern struct child_pid *children;
149 extern int num_children;
150
151 struct tstream_context;
152 struct smbd_smb2_request;
153 struct smbd_smb2_session;
154 struct smbd_smb2_tcon;
155
156 DATA_BLOB negprot_spnego(void);
157
158 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
159                                struct iovec *vector,
160                                int count);
161 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
162                                 const struct iovec *vector,
163                                 int count);
164
165 struct smbd_lock_element {
166         uint32_t smbpid;
167         enum brl_type brltype;
168         uint64_t offset;
169         uint64_t count;
170 };
171
172 NTSTATUS smbd_do_locking(struct smb_request *req,
173                          files_struct *fsp,
174                          uint8_t type,
175                          int32_t timeout,
176                          uint16_t num_ulocks,
177                          struct smbd_lock_element *ulocks,
178                          uint16_t num_locks,
179                          struct smbd_lock_element *locks,
180                          bool *async);
181
182 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
183                                TALLOC_CTX *mem_ctx,
184                                uint16_t info_level,
185                                files_struct *fsp,
186                                struct smb_filename *smb_fname,
187                                bool delete_pending,
188                                struct timespec write_time_ts,
189                                bool ms_dfs_link,
190                                struct ea_list *ea_list,
191                                int lock_data_count,
192                                char *lock_data,
193                                uint16_t flags2,
194                                unsigned int max_data_bytes,
195                                char **ppdata,
196                                unsigned int *pdata_size);
197
198 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
199                                 struct smb_request *req,
200                                 TALLOC_CTX *mem_ctx,
201                                 uint16_t info_level,
202                                 files_struct *fsp,
203                                 struct smb_filename *smb_fname,
204                                 char **ppdata, int total_data,
205                                 int *ret_data_size);
206
207 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
208                          TALLOC_CTX *mem_ctx,
209                          uint16_t info_level,
210                          uint16_t flags2,
211                          unsigned int max_data_bytes,
212                          char **ppdata,
213                          int *ret_data_len);
214
215 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
216                            struct dptr_struct *dirptr,
217                            const char *mask,
218                            uint32_t dirtype,
219                            bool dont_descend,
220                            bool ask_sharemode,
221                            bool (*match_fn)(TALLOC_CTX *ctx,
222                                             void *private_data,
223                                             const char *dname,
224                                             const char *mask,
225                                             char **_fname),
226                            bool (*mode_fn)(TALLOC_CTX *ctx,
227                                            void *private_data,
228                                            struct smb_filename *smb_fname,
229                                            uint32_t *_mode),
230                            void *private_data,
231                            char **_fname,
232                            struct smb_filename **_smb_fname,
233                            uint32_t *_mode,
234                            long *_prev_offset);
235
236 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
237                                connection_struct *conn,
238                                struct dptr_struct *dirptr,
239                                uint16 flags2,
240                                const char *path_mask,
241                                uint32 dirtype,
242                                int info_level,
243                                int requires_resume_key,
244                                bool dont_descend,
245                                bool ask_sharemode,
246                                uint8_t align,
247                                bool do_pad,
248                                char **ppdata,
249                                char *base_data,
250                                char *end_data,
251                                int space_remaining,
252                                bool *out_of_space,
253                                bool *got_exact_match,
254                                int *_last_entry_off,
255                                struct ea_list *name_list);
256
257 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
258                                 const struct smb_filename *smb_fname,
259                                 uint32_t access_mask,
260                                 uint32_t *access_granted);
261
262 void smbd_notify_cancel_by_smbreq(struct smbd_server_connection *sconn,
263                                   const struct smb_request *smbreq);
264
265 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
266                                          const char *reason,
267                                          const char *location);
268 #define smbd_server_connection_terminate(sconn, reason) \
269         smbd_server_connection_terminate_ex(sconn, reason, __location__)
270
271 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
272
273 void reply_smb2002(struct smb_request *req, uint16_t choice);
274 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
275                              const uint8_t *inbuf, size_t size);
276
277 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
278                                     NTSTATUS status,
279                                     DATA_BLOB *info,
280                                     const char *location);
281 #define smbd_smb2_request_error(req, status) \
282         smbd_smb2_request_error_ex(req, status, NULL, __location__)
283 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
284                                    NTSTATUS status,
285                                    DATA_BLOB body, DATA_BLOB *dyn,
286                                    const char *location);
287 #define smbd_smb2_request_done(req, body, dyn) \
288         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
289
290 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
291                                      uint64_t file_id_persistent,
292                                      uint64_t file_id_volatile,
293                                      uint8_t oplock_level);
294
295 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
296                                          struct tevent_req *subreq);
297
298 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
300
301 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
302
303 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
307 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
308 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
309 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
310 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
311 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
312 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
313 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
314 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
315 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
316 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
317 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
318 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
319 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
320 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
321
322 struct smbd_smb2_request {
323         struct smbd_smb2_request *prev, *next;
324
325         TALLOC_CTX *mem_pool;
326         struct smbd_smb2_request **parent;
327
328         struct smbd_server_connection *sconn;
329
330         /* the session the request operates on, maybe NULL */
331         struct smbd_smb2_session *session;
332
333         /* the tcon the request operates on, maybe NULL */
334         struct smbd_smb2_tcon *tcon;
335
336         int current_idx;
337         bool do_signing;
338
339         struct files_struct *compat_chain_fsp;
340
341         NTSTATUS next_status;
342
343         /*
344          * The sub request for async backend calls.
345          * This is used for SMB2 Cancel.
346          */
347         struct tevent_req *subreq;
348
349         struct {
350                 /* the NBT header is not allocated */
351                 uint8_t nbt_hdr[4];
352                 /*
353                  * vector[0] NBT
354                  * .
355                  * vector[1] SMB2
356                  * vector[2] fixed body
357                  * vector[3] dynamic body
358                  * .
359                  * .
360                  * .
361                  * vector[4] SMB2
362                  * vector[5] fixed body
363                  * vector[6] dynamic body
364                  * .
365                  * .
366                  * .
367                  */
368                 struct iovec *vector;
369                 int vector_count;
370         } in;
371         struct {
372                 /* the NBT header is not allocated */
373                 uint8_t nbt_hdr[4];
374                 /*
375                  * vector[0] NBT
376                  * .
377                  * vector[1] SMB2
378                  * vector[2] fixed body
379                  * vector[3] dynamic body
380                  * .
381                  * .
382                  * .
383                  * vector[4] SMB2
384                  * vector[5] fixed body
385                  * vector[6] dynamic body
386                  * .
387                  * .
388                  * .
389                  */
390                 struct iovec *vector;
391                 int vector_count;
392         } out;
393 };
394
395 struct smbd_server_connection;
396
397 struct smbd_smb2_session {
398         struct smbd_smb2_session *prev, *next;
399         struct smbd_server_connection *sconn;
400         NTSTATUS status;
401         uint64_t vuid;
402         AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
403         struct auth_serversupplied_info *server_info;
404         DATA_BLOB session_key;
405         bool do_signing;
406
407         user_struct *compat_vuser;
408
409         struct {
410                 /* an id tree used to allocate tids */
411                 struct idr_context *idtree;
412
413                 /* this is the limit of tid values for this connection */
414                 uint32_t limit;
415
416                 struct smbd_smb2_tcon *list;
417         } tcons;
418 };
419
420 struct smbd_smb2_tcon {
421         struct smbd_smb2_tcon *prev, *next;
422         struct smbd_smb2_session *session;
423         uint32_t tid;
424         int snum;
425         connection_struct *compat_conn;
426 };
427
428 struct pending_auth_data;
429
430 struct smbd_server_connection {
431         struct {
432                 bool got_session;
433         } nbt;
434         bool allow_smb2;
435         struct {
436                 struct fd_event *fde;
437                 uint64_t num_requests;
438                 struct {
439                         bool encrypted_passwords;
440                         bool spnego;
441                         struct auth_context *auth_context;
442                         bool done;
443                         /*
444                          * Size of the data we can receive. Set by us.
445                          * Can be modified by the max xmit parameter.
446                          */
447                         int max_recv;
448                 } negprot;
449
450                 struct {
451                         bool done_sesssetup;
452                         /*
453                          * Size of data we can send to client. Set
454                          *  by the client for all protocols above CORE.
455                          *  Set by us for CORE protocol.
456                          */
457                         int max_send;
458                         uint16_t last_session_tag;
459
460                         /* users from session setup */
461                         char *session_userlist;
462                         /* workgroup from session setup. */
463                         char *session_workgroup;
464                         /*
465                          * this holds info on user ids that are already
466                          * validated for this VC
467                          */
468                         user_struct *validated_users;
469                         uint16_t next_vuid;
470                         int num_validated_vuids;
471 #ifdef HAVE_NETGROUP
472                         char *my_yp_domain;
473 #endif
474                 } sessions;
475                 struct {
476                         connection_struct *Connections;
477                         /* number of open connections */
478                         struct bitmap *bmap;
479                         int num_open;
480                 } tcons;
481                 struct smb_signing_state *signing_state;
482                 /* List to store partial SPNEGO auth fragments. */
483                 struct pending_auth_data *pd_list;
484
485                 struct notify_mid_map *notify_mid_maps;
486
487                 struct {
488                         struct bitmap *dptr_bmap;
489                         struct dptr_struct *dirptrs;
490                         int dirhandles_open;
491                 } searches;
492         } smb1;
493         struct {
494                 struct tevent_context *event_ctx;
495                 struct tevent_queue *recv_queue;
496                 struct tevent_queue *send_queue;
497                 struct tstream_context *stream;
498                 struct {
499                         /* an id tree used to allocate vuids */
500                         /* this holds info on session vuids that are already
501                          * validated for this VC */
502                         struct idr_context *idtree;
503
504                         /* this is the limit of vuid values for this connection */
505                         uint64_t limit;
506
507                         struct smbd_smb2_session *list;
508                 } sessions;
509                 struct smbd_smb2_request *requests;
510         } smb2;
511 };
512
513 extern struct smbd_server_connection *smbd_server_conn;
514
515 void smbd_init_globals(void);