s3:smbd: implement FSCTL_SMBTORTURE_FORCE_UNACKED_TIMEOUT
[gd/samba-autobuild/.git] / source3 / smbd / globals.h
1 /*
2    Unix SMB/Netbios implementation.
3    smbd globals
4    Copyright (C) Stefan Metzmacher 2009
5    Copyright (C) Jeremy Allison 2010
6
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.
11
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.
16
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/>.
19 */
20
21 #ifndef _SOURCE3_SMBD_GLOBALS_H_
22 #define _SOURCE3_SMBD_GLOBALS_H_
23
24 #include "system/select.h"
25 #include "librpc/gen_ndr/smbXsrv.h"
26 #include "smbprofile.h"
27
28 #ifdef USE_DMAPI
29 struct smbd_dmapi_context;
30 extern struct smbd_dmapi_context *dmapi_ctx;
31 #endif
32
33 /* A singleton cache to speed up searching by dev/inode. */
34 struct fsp_singleton_cache {
35         files_struct *fsp;
36         struct file_id id;
37 };
38
39 extern const struct mangle_fns *mangle_fns;
40
41 extern unsigned char *chartest;
42 struct tdb_context;
43 extern struct tdb_context *tdb_mangled_cache;
44
45 /*
46   this determines how many characters are used from the original filename
47   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
48   The largest possible value is 6.
49 */
50 extern unsigned mangle_prefix;
51
52 struct msg_state;
53
54 extern bool logged_ioctl_message;
55
56 extern int trans_num;
57
58 extern time_t last_smb_conf_reload_time;
59 extern time_t last_printer_reload_time;
60 extern pid_t background_lpq_updater_pid;
61
62 /****************************************************************************
63  structure to hold a linked list of queued messages.
64  for processing.
65 ****************************************************************************/
66 extern uint32_t common_flags2;
67
68 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
69 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
70
71 struct sec_ctx {
72         struct security_unix_token ut;
73         struct security_token *token;
74 };
75 /* A stack of security contexts.  We include the current context as being
76    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
77 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
78 extern int sec_ctx_stack_ndx;
79 extern bool become_uid_done;
80 extern bool become_gid_done;
81
82 extern connection_struct *last_conn;
83 extern uint16_t last_flags;
84
85 extern uint32_t global_client_caps;
86
87 extern uint16_t fnf_handle;
88
89 struct conn_ctx {
90         connection_struct *conn;
91         uint64_t vuid;
92         userdom_struct user_info;
93 };
94 /* A stack of current_user connection contexts. */
95 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
96 extern int conn_ctx_stack_ndx;
97
98 struct vfs_init_function_entry;
99 extern struct vfs_init_function_entry *backends;
100 extern char *sparse_buf;
101 extern char *LastDir;
102
103 struct smbd_parent_context;
104 extern struct smbd_parent_context *am_parent;
105 extern struct memcache *smbd_memcache_ctx;
106 extern bool exit_firsttime;
107
108 struct tstream_context;
109 struct smbd_smb2_request;
110
111 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
112
113 void smbd_lock_socket(struct smbXsrv_connection *xconn);
114 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
115
116 struct GUID smbd_request_guid(struct smb_request *smb1req, uint16_t idx);
117
118 NTSTATUS smbd_do_unlocking(struct smb_request *req,
119                            files_struct *fsp,
120                            uint16_t num_ulocks,
121                            struct smbd_lock_element *ulocks,
122                            enum brl_flavour lock_flav);
123
124 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
125                                TALLOC_CTX *mem_ctx,
126                                struct smb_request *req,
127                                uint16_t info_level,
128                                files_struct *fsp,
129                                struct smb_filename *smb_fname,
130                                bool delete_pending,
131                                struct timespec write_time_ts,
132                                struct ea_list *ea_list,
133                                int lock_data_count,
134                                char *lock_data,
135                                uint16_t flags2,
136                                unsigned int max_data_bytes,
137                                size_t *fixed_portion,
138                                char **ppdata,
139                                unsigned int *pdata_size);
140
141 NTSTATUS smbd_do_setfsinfo(connection_struct *conn,
142                                 struct smb_request *req,
143                                 TALLOC_CTX *mem_ctx,
144                                 uint16_t info_level,
145                                 files_struct *fsp,
146                                 const DATA_BLOB *pdata);
147
148 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
149                                 struct smb_request *req,
150                                 TALLOC_CTX *mem_ctx,
151                                 uint16_t info_level,
152                                 files_struct *fsp,
153                                 struct smb_filename *smb_fname,
154                                 char **ppdata, int total_data,
155                                 int *ret_data_size);
156
157 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
158                          connection_struct *conn,
159                          TALLOC_CTX *mem_ctx,
160                          uint16_t info_level,
161                          uint16_t flags2,
162                          unsigned int max_data_bytes,
163                          size_t *fixed_portion,
164                          struct smb_filename *smb_fname,
165                          char **ppdata,
166                          int *ret_data_len);
167
168 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
169                            struct dptr_struct *dirptr,
170                            const char *mask,
171                            uint32_t dirtype,
172                            bool dont_descend,
173                            bool ask_sharemode,
174                            bool get_dosmode,
175                            bool (*match_fn)(TALLOC_CTX *ctx,
176                                             void *private_data,
177                                             const char *dname,
178                                             const char *mask,
179                                             char **_fname),
180                            bool (*mode_fn)(TALLOC_CTX *ctx,
181                                            void *private_data,
182                                            struct smb_filename *smb_fname,
183                                            bool get_dosmode,
184                                            uint32_t *_mode),
185                            void *private_data,
186                            char **_fname,
187                            struct smb_filename **_smb_fname,
188                            uint32_t *_mode,
189                            long *_prev_offset);
190
191 NTSTATUS smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
192                                connection_struct *conn,
193                                struct dptr_struct *dirptr,
194                                uint16_t flags2,
195                                const char *path_mask,
196                                uint32_t dirtype,
197                                int info_level,
198                                int requires_resume_key,
199                                bool dont_descend,
200                                bool ask_sharemode,
201                                bool get_dosmode,
202                                uint8_t align,
203                                bool do_pad,
204                                char **ppdata,
205                                char *base_data,
206                                char *end_data,
207                                int space_remaining,
208                                struct smb_filename **smb_fname,
209                                bool *got_exact_match,
210                                int *_last_entry_off,
211                                struct ea_list *name_list,
212                                struct file_id *file_id);
213
214 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
215                         struct files_struct *dirfsp,
216                         const struct smb_filename *smb_fname,
217                         bool use_privs,
218                         uint32_t access_mask,
219                         uint32_t *access_mask_out);
220
221 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
222
223 void smbXsrv_connection_disconnect_transport(struct smbXsrv_connection *xconn,
224                                              NTSTATUS status);
225 size_t smbXsrv_client_valid_connections(struct smbXsrv_client *client);
226 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
227                                          const char *reason,
228                                          const char *location);
229 #define smbd_server_connection_terminate(xconn, reason) \
230         smbd_server_connection_terminate_ex(xconn, reason, __location__)
231
232 void smbd_server_disconnect_client_ex(struct smbXsrv_client *client,
233                                       const char *reason,
234                                       const char *location);
235 #define smbd_server_disconnect_client(__client, __reason) \
236         smbd_server_disconnect_client_ex(__client, __reason, __location__)
237
238 const char *smb2_opcode_name(uint16_t opcode);
239 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
240 bool smbd_smb2_is_compound(const struct smbd_smb2_request *req);
241
242 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
243                              NTTIME now, struct smbXsrv_connection **_xconn);
244
245 NTSTATUS reply_smb2002(struct smb_request *req, uint16_t choice);
246 NTSTATUS reply_smb20ff(struct smb_request *req, uint16_t choice);
247 NTSTATUS smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
248                                uint64_t expected_seq_low,
249                                const uint8_t *inpdu, size_t size);
250
251 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
252
253 bool smbXsrv_server_multi_channel_enabled(void);
254
255 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
256                                     NTSTATUS status,
257                                     DATA_BLOB *info,
258                                     const char *location);
259 #define smbd_smb2_request_error(req, status) \
260         smbd_smb2_request_error_ex(req, status, NULL, __location__)
261 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
262                                    NTSTATUS status,
263                                    DATA_BLOB body, DATA_BLOB *dyn,
264                                    const char *location);
265 #define smbd_smb2_request_done(req, body, dyn) \
266         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
267
268 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_client *client,
269                                      struct smbXsrv_open *op,
270                                      uint8_t oplock_level);
271 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_client *client,
272                                     uint16_t new_epoch,
273                                     uint32_t lease_flags,
274                                     struct smb2_lease_key *lease_key,
275                                     uint32_t current_lease_state,
276                                     uint32_t new_lease_state);
277
278 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
279                                          struct tevent_req *subreq,
280                                          uint32_t defer_time);
281
282 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
283 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
284 void remove_smb2_chained_fsp(files_struct *fsp);
285
286 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
287                                                uint32_t data_length);
288
289 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
290                                         size_t expected_body_size);
291
292 void smb2_request_set_async_internal(struct smbd_smb2_request *req,
293                                      bool async_internal);
294
295 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
296                                                      const int dialect_count,
297                                                      uint16_t *dialect);
298 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
307 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
308 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
309 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
310 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
311                                     int err);
312 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
313 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
314 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
315 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
316 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
317 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
318 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
319 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
320 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
321 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
322                                 struct tevent_immediate *im,
323                                 void *private_data);
324
325 struct deferred_open_record;
326
327 /* SMB1 -> SMB2 glue. */
328 void send_break_message_smb2(files_struct *fsp,
329                              uint32_t break_from,
330                              uint32_t break_to);
331 /* From smbd/smb2_create.c */
332 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
333 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
334                         struct timeval *p_request_time,
335                         struct deferred_open_record **open_rec);
336 bool open_was_deferred_smb2(
337         struct smbXsrv_connection *xconn, uint64_t mid);
338 void remove_deferred_open_message_smb2(
339         struct smbXsrv_connection *xconn, uint64_t mid);
340 bool schedule_deferred_open_message_smb2(
341         struct smbXsrv_connection *xconn, uint64_t mid);
342 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
343                                 struct timeval request_time,
344                                 struct timeval timeout,
345                                 struct file_id id,
346                                 struct deferred_open_record *open_rec);
347
348 struct smbXsrv_client;
349
350 struct smbXsrv_preauth {
351         uint8_t sha512_value[64];
352 };
353
354 struct smbXsrv_connection {
355         struct smbXsrv_connection *prev, *next;
356
357         struct smbXsrv_client *client;
358
359         NTTIME connect_time;
360         uint64_t channel_id;
361         const struct tsocket_address *local_address;
362         const struct tsocket_address *remote_address;
363         const char *remote_hostname;
364
365         enum protocol_types protocol;
366
367         struct {
368                 NTSTATUS status;
369                 int sock;
370                 struct tevent_fd *fde;
371
372                 struct {
373                         bool got_session;
374                 } nbt;
375         } transport;
376
377         struct {
378                 bool force_unacked_timeout;
379                 uint64_t unacked_bytes;
380                 uint32_t rto_usecs;
381                 struct tevent_req *checker_subreq;
382                 struct smbd_smb2_send_queue *queue;
383         } ack;
384
385         struct {
386                 struct {
387                         /*
388                          * fd for the fcntl lock and process shared
389                          * robust mutex to coordinate access to the
390                          * client socket. When the system supports
391                          * process shared robust mutexes, those are
392                          * used. If not, then the fcntl lock will be
393                          * used.
394                          */
395                         int socket_lock_fd;
396 #ifdef HAVE_ROBUST_MUTEXES
397                         pthread_mutex_t *socket_mutex;
398 #endif
399
400                         /*
401                          * fd for the trusted pipe from
402                          * echo handler child
403                          */
404                         int trusted_fd;
405
406                         /*
407                          * fde for the trusted_fd
408                          */
409                         struct tevent_fd *trusted_fde;
410
411                         /*
412                          * Reference count for the fcntl lock to
413                          * allow recursive locks.
414                          */
415                         int ref_count;
416                 } echo_handler;
417
418                 struct {
419                         bool encrypted_passwords;
420                         bool spnego;
421                         struct auth4_context *auth_context;
422                         bool done;
423                         /*
424                          * Size of the data we can receive. Set by us.
425                          * Can be modified by the max xmit parameter.
426                          */
427                         int max_recv;
428                 } negprot;
429
430                 struct {
431                         bool done_sesssetup;
432                         /*
433                          * Size of data we can send to client. Set
434                          *  by the client for all protocols above CORE.
435                          *  Set by us for CORE protocol.
436                          */
437                         int max_send;
438                 } sessions;
439                 struct smb_signing_state *signing_state;
440
441                 struct {
442                         uint16_t client_major;
443                         uint16_t client_minor;
444                         uint32_t client_cap_low;
445                         uint32_t client_cap_high;
446                 } unix_info;
447
448                 struct msg_state *msg_state;
449         } smb1;
450         struct {
451                 struct smbd_smb2_request_read_state {
452                         struct smbd_smb2_request *req;
453                         struct {
454                                 uint8_t nbt[NBT_HDR_SIZE];
455                                 bool done;
456                         } hdr;
457                         struct iovec vector;
458                         bool doing_receivefile;
459                         size_t min_recv_size;
460                         size_t pktfull;
461                         size_t pktlen;
462                         uint8_t *pktbuf;
463                 } request_read_state;
464                 struct smbd_smb2_send_queue *send_queue;
465                 size_t send_queue_len;
466
467                 struct {
468                         /*
469                          * seq_low is the lowest sequence number
470                          * we will accept.
471                          */
472                         uint64_t seq_low;
473                         /*
474                          * seq_range is the range of credits we have
475                          * granted from the sequence windows starting
476                          * at seq_low.
477                          *
478                          * This gets incremented when new credits are
479                          * granted and gets decremented when the
480                          * lowest sequence number is consumed
481                          * (when seq_low gets incremented).
482                          */
483                         uint16_t seq_range;
484                         /*
485                          * The number of credits we have currently granted
486                          * to the client.
487                          *
488                          * This gets incremented when new credits are
489                          * granted and gets decremented when any credit
490                          * is comsumed.
491                          *
492                          * Note: the decrementing is different compared
493                          *       to seq_range.
494                          */
495                         uint16_t granted;
496                         /*
497                          * The maximum number of credits we will ever
498                          * grant to the client.
499                          *
500                          * Typically we will only grant 1/16th of
501                          * max_credits.
502                          *
503                          * This is the "server max credits" parameter.
504                          */
505                         uint16_t max;
506                         /*
507                          * a bitmap of size max_credits
508                          */
509                         struct bitmap *bitmap;
510                         bool multicredit;
511                 } credits;
512
513                 bool allow_2ff;
514                 struct {
515                         uint32_t capabilities;
516                         struct GUID guid;
517                         bool guid_verified;
518                         uint16_t security_mode;
519                         uint16_t num_dialects;
520                         uint16_t *dialects;
521                 } client;
522                 struct {
523                         uint32_t capabilities;
524                         struct GUID guid;
525                         uint16_t security_mode;
526                         uint16_t dialect;
527                         uint32_t max_trans;
528                         uint32_t max_read;
529                         uint32_t max_write;
530                         uint16_t cipher;
531                 } server;
532
533                 struct smbXsrv_preauth preauth;
534
535                 struct smbd_smb2_request *requests;
536         } smb2;
537 };
538
539 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
540
541 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
542 uint32_t smbXsrv_version_global_current(void);
543
544 struct smbXsrv_client_table;
545 NTSTATUS smbXsrv_client_global_init(void);
546 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
547                                struct tevent_context *ev_ctx,
548                                struct messaging_context *msg_ctx,
549                                NTTIME now,
550                                struct smbXsrv_client **_client);
551 NTSTATUS smbXsrv_client_update(struct smbXsrv_client *client);
552 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
553 NTSTATUS smb2srv_client_lookup_global(struct smbXsrv_client *client,
554                                       struct GUID client_guid,
555                                       TALLOC_CTX *mem_ctx,
556                                       struct smbXsrv_client_global0 **_pass);
557 NTSTATUS smb2srv_client_connection_pass(struct smbd_smb2_request *smb2req,
558                                         struct smbXsrv_client_global0 *global);
559
560 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
561                                         enum protocol_types protocol);
562
563 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
564 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
565                                 NTTIME now,
566                                 struct smbXsrv_session **_session);
567 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
568                                      struct smbXsrv_connection *conn,
569                                      NTTIME now,
570                                      struct smbXsrv_channel_global0 **_c);
571 NTSTATUS smbXsrv_session_disconnect_xconn(struct smbXsrv_connection *xconn);
572 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
573 struct smbXsrv_channel_global0;
574 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
575                                       const struct smbXsrv_connection *conn,
576                                       struct smbXsrv_channel_global0 **_c);
577 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
578                                    const struct smbXsrv_connection *conn,
579                                    NTTIME now,
580                                    struct smbXsrv_session_auth0 **_a);
581 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
582                                      struct smbXsrv_connection *conn,
583                                      NTTIME now,
584                                      uint8_t in_flags,
585                                      uint8_t in_security_mode,
586                                      struct smbXsrv_session_auth0 **_a);
587 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
588                                         struct tevent_context *ev,
589                                         struct smbXsrv_session *session,
590                                         struct smbd_smb2_request *current_req);
591 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
592 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
593 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_client *client);
594 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
595 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
596                                 uint16_t vuid, NTTIME now,
597                                 struct smbXsrv_session **session);
598 NTSTATUS smbXsrv_session_info_lookup(struct smbXsrv_client *client,
599                                      uint64_t session_wire_id,
600                                      struct auth_session_info **si);
601 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
602 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
603                                      uint64_t session_id, NTTIME now,
604                                      struct smbXsrv_session **session);
605 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
606                                        uint64_t session_id, NTTIME now,
607                                        struct smbXsrv_session **session);
608 NTSTATUS get_valid_smbXsrv_session(struct smbXsrv_client *client,
609                                    uint64_t session_wire_id,
610                                    struct smbXsrv_session **session);
611 NTSTATUS smbXsrv_session_local_traverse(
612         struct smbXsrv_client *client,
613         int (*caller_cb)(struct smbXsrv_session *session,
614                               void *caller_data),
615         void *caller_data);
616 struct smbXsrv_session_global0;
617 NTSTATUS smbXsrv_session_global_traverse(
618                         int (*fn)(struct smbXsrv_session_global0 *, void *),
619                         void *private_data);
620 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
621                                         struct tevent_context *ev,
622                                         struct smbXsrv_connection *conn,
623                                         struct auth_session_info *session_info,
624                                         uint64_t previous_session_id,
625                                         uint64_t current_session_id);
626 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
627
628 NTSTATUS smbXsrv_tcon_global_init(void);
629 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
630 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
631 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
632 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
633                              NTTIME now,
634                              struct smbXsrv_tcon **_tcon);
635 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
636                              uint16_t tree_id, NTTIME now,
637                              struct smbXsrv_tcon **tcon);
638 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_client *client);
639 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
640 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
641                              NTTIME now,
642                              struct smbXsrv_tcon **_tcon);
643 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
644                              uint32_t tree_id, NTTIME now,
645                              struct smbXsrv_tcon **tcon);
646 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
647 struct smbXsrv_tcon_global0;
648 NTSTATUS smbXsrv_tcon_global_traverse(
649                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
650                         void *private_data);
651
652 NTSTATUS smbXsrv_open_global_init(void);
653 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
654                              struct auth_session_info *session_info,
655                              NTTIME now,
656                              struct smbXsrv_open **_open);
657 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
658 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
659 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
660 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
661                              uint16_t fnum, NTTIME now,
662                              struct smbXsrv_open **_open);
663 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
664 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
665                              uint64_t persistent_id,
666                              uint64_t volatile_id,
667                              NTTIME now,
668                              struct smbXsrv_open **_open);
669 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
670                                           const struct GUID *create_guid,
671                                           NTTIME now,
672                                           struct smbXsrv_open **_open);
673 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
674                                struct auth_session_info *session_info,
675                                uint64_t persistent_id,
676                                const struct GUID *create_guid,
677                                NTTIME now,
678                                struct smbXsrv_open **_open);
679 struct smbXsrv_open_global0;
680 NTSTATUS smbXsrv_open_global_traverse(
681         int (*fn)(struct smbXsrv_open_global0 *, void *),
682         void *private_data);
683
684 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
685 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
686 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
687 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
688 bool smbXsrv_is_signed(uint8_t signing_flags);
689 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
690
691 struct smbd_smb2_send_queue {
692         struct smbd_smb2_send_queue *prev, *next;
693
694         DATA_BLOB *sendfile_header;
695         uint32_t sendfile_body_size;
696         NTSTATUS *sendfile_status;
697         struct iovec *vector;
698         int count;
699
700         struct {
701                 struct tevent_req *req;
702                 struct timeval timeout;
703                 uint64_t required_acked_bytes;
704         } ack;
705
706         TALLOC_CTX *mem_ctx;
707 };
708
709 struct smbd_smb2_request {
710         struct smbd_smb2_request *prev, *next;
711
712         struct smbd_server_connection *sconn;
713         struct smbXsrv_connection *xconn;
714
715         struct smbd_smb2_send_queue queue_entry;
716
717         /* the session the request operates on, maybe NULL */
718         struct smbXsrv_session *session;
719         uint64_t last_session_id;
720
721         /* the tcon the request operates on, maybe NULL */
722         struct smbXsrv_tcon *tcon;
723         uint32_t last_tid;
724
725         int current_idx;
726         bool do_signing;
727         /* Was the request encrypted? */
728         bool was_encrypted;
729         /* Should we encrypt? */
730         bool do_encryption;
731         struct tevent_timer *async_te;
732         bool compound_related;
733
734         /*
735          * Give the implementation of an SMB2 req a way to tell the SMB2 request
736          * processing engine that the internal request is going async, while
737          * preserving synchronous SMB2 behaviour.
738          */
739         bool async_internal;
740
741         /*
742          * the encryption key for the whole
743          * compound chain
744          */
745         DATA_BLOB first_key;
746         /*
747          * the signing key for the last
748          * request/response of a compound chain
749          */
750         DATA_BLOB last_key;
751         struct smbXsrv_preauth *preauth;
752
753         struct timeval request_time;
754
755         SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
756
757         /* fake smb1 request. */
758         struct smb_request *smb1req;
759         struct files_struct *compat_chain_fsp;
760
761         /*
762          * Keep track of whether the outstanding request counters
763          * had been updated in dispatch, so that they need to be
764          * adapted again in reply.
765          */
766         bool request_counters_updated;
767         uint64_t channel_generation;
768
769         /*
770          * The sub request for async backend calls.
771          * This is used for SMB2 Cancel.
772          */
773         struct tevent_req *subreq;
774
775 #define SMBD_SMB2_TF_IOV_OFS 0
776 #define SMBD_SMB2_HDR_IOV_OFS 1
777 #define SMBD_SMB2_BODY_IOV_OFS 2
778 #define SMBD_SMB2_DYN_IOV_OFS 3
779
780 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
781
782 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
783         (&req->dir.vector[(idx)+(ofs)])
784
785 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
786         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
787 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
788         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
789 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
790         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
791 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
792         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
793
794 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
795 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
796 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
797 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
798 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
799 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
800 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
801 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
802 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
803 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
804
805 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
806 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
807 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
808 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
809 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
810 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
811 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
812 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
813 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
814 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
815
816 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
817
818         struct {
819                 /*
820                  * vector[0] TRANSPORT HEADER (empty)
821                  * .
822                  * vector[1] SMB2_TRANSFORM (optional)
823                  * vector[2] SMB2
824                  * vector[3] fixed body
825                  * vector[4] dynamic body
826                  * .
827                  * .
828                  * .
829                  * vector[5] SMB2_TRANSFORM (optional)
830                  * vector[6] SMB2
831                  * vector[7] fixed body
832                  * vector[8] dynamic body
833                  * .
834                  * .
835                  * .
836                  */
837                 struct iovec *vector;
838                 int vector_count;
839                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
840         } in;
841         struct {
842                 /* the NBT header is not allocated */
843                 uint8_t nbt_hdr[4];
844                 /*
845                  * vector[0] TRANSPORT HEADER
846                  * .
847                  * vector[1] SMB2_TRANSFORM (optional)
848                  * vector[2] SMB2
849                  * vector[3] fixed body
850                  * vector[4] dynamic body
851                  * .
852                  * .
853                  * .
854                  * vector[5] SMB2_TRANSFORM (empty)
855                  * vector[6] SMB2
856                  * vector[7] fixed body
857                  * vector[8] dynamic body
858                  * .
859                  * .
860                  * .
861                  */
862                 struct iovec *vector;
863                 int vector_count;
864                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
865 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
866                 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
867                 uint8_t _body[0x58];
868         } out;
869 };
870
871 struct smbd_server_connection;
872
873 struct pending_message_list;
874 struct pending_auth_data;
875
876 struct pthreadpool_tevent;
877 struct dcesrv_context;
878
879 struct smbd_server_connection {
880         const struct tsocket_address *local_address;
881         const struct tsocket_address *remote_address;
882         const char *remote_hostname;
883         struct tevent_context *ev_ctx;
884         struct messaging_context *msg_ctx;
885         struct dcesrv_context *dce_ctx;
886         struct notify_context *notify_ctx;
887         bool using_smb2;
888         int trans_num;
889
890         size_t num_users;
891
892         size_t num_connections;
893         struct connection_struct *connections;
894
895         size_t num_files;
896         struct files_struct *files;
897
898         int real_max_open_files;
899         struct fsp_singleton_cache fsp_fi_cache;
900
901         struct pending_message_list *deferred_open_queue;
902
903
904         /* open directory handles. */
905         struct {
906                 struct bitmap *dptr_bmap;
907                 struct dptr_struct *dirptrs;
908         } searches;
909
910         uint64_t num_requests;
911
912         /* Current number of oplocks we have outstanding. */
913         struct {
914                 int32_t exclusive_open;
915                 int32_t level_II_open;
916                 struct kernel_oplocks *kernel_ops;
917         } oplocks;
918
919         struct {
920                 struct notify_mid_map *notify_mid_maps;
921         } smb1;
922
923         struct pthreadpool_tevent *pool;
924
925         struct smbXsrv_client *client;
926 };
927
928 extern struct smbXsrv_client *global_smbXsrv_client;
929
930 void smbd_init_globals(void);
931
932 #endif /* _SOURCE3_SMBD_GLOBALS_H_ */