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