s3:smbd: implement FSCTL_SMBTORTURE_GLOBAL_READ_RESPONSE_BODY_PADDING8
[kseeger/samba-autobuild-v4-15-test/.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 files_struct *dirfsp,
183                                            struct smb_filename *atname,
184                                            struct smb_filename *smb_fname,
185                                            bool get_dosmode,
186                                            uint32_t *_mode),
187                            void *private_data,
188                            char **_fname,
189                            struct smb_filename **_smb_fname,
190                            uint32_t *_mode,
191                            long *_prev_offset);
192
193 NTSTATUS smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
194                                connection_struct *conn,
195                                struct dptr_struct *dirptr,
196                                uint16_t flags2,
197                                const char *path_mask,
198                                uint32_t dirtype,
199                                int info_level,
200                                int requires_resume_key,
201                                bool dont_descend,
202                                bool ask_sharemode,
203                                bool get_dosmode,
204                                uint8_t align,
205                                bool do_pad,
206                                char **ppdata,
207                                char *base_data,
208                                char *end_data,
209                                int space_remaining,
210                                struct smb_filename **smb_fname,
211                                bool *got_exact_match,
212                                int *_last_entry_off,
213                                struct ea_list *name_list,
214                                struct file_id *file_id);
215
216 NTSTATUS smbd_calculate_access_mask_fsp(struct files_struct *dirsfp,
217                         struct files_struct *fsp,
218                         bool use_privs,
219                         uint32_t access_mask,
220                         uint32_t *access_mask_out);
221
222 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
223
224 void smbXsrv_connection_disconnect_transport(struct smbXsrv_connection *xconn,
225                                              NTSTATUS status);
226 size_t smbXsrv_client_valid_connections(struct smbXsrv_client *client);
227 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
228                                          const char *reason,
229                                          const char *location);
230 #define smbd_server_connection_terminate(xconn, reason) \
231         smbd_server_connection_terminate_ex(xconn, reason, __location__)
232
233 void smbd_server_disconnect_client_ex(struct smbXsrv_client *client,
234                                       const char *reason,
235                                       const char *location);
236 #define smbd_server_disconnect_client(__client, __reason) \
237         smbd_server_disconnect_client_ex(__client, __reason, __location__)
238
239 const char *smb2_opcode_name(uint16_t opcode);
240 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
241 bool smbd_smb2_is_compound(const struct smbd_smb2_request *req);
242
243 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
244                              NTTIME now, struct smbXsrv_connection **_xconn);
245
246 NTSTATUS reply_smb2002(struct smb_request *req, uint16_t choice);
247 NTSTATUS reply_smb20ff(struct smb_request *req, uint16_t choice);
248 NTSTATUS smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
249                                uint64_t expected_seq_low,
250                                const uint8_t *inpdu, size_t size);
251
252 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
253
254 bool smbXsrv_server_multi_channel_enabled(void);
255
256 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
257                                     NTSTATUS status,
258                                     DATA_BLOB *info,
259                                     const char *location);
260 #define smbd_smb2_request_error(req, status) \
261         smbd_smb2_request_error_ex(req, status, NULL, __location__)
262 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
263                                    NTSTATUS status,
264                                    DATA_BLOB body, DATA_BLOB *dyn,
265                                    const char *location);
266 #define smbd_smb2_request_done(req, body, dyn) \
267         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
268
269 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_client *client,
270                                      struct smbXsrv_open *op,
271                                      uint8_t oplock_level);
272 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_client *client,
273                                     uint16_t new_epoch,
274                                     uint32_t lease_flags,
275                                     struct smb2_lease_key *lease_key,
276                                     uint32_t current_lease_state,
277                                     uint32_t new_lease_state);
278
279 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
280                                          struct tevent_req *subreq,
281                                          uint32_t defer_time);
282
283 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
284 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
285 void remove_smb2_chained_fsp(files_struct *fsp);
286
287 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
288                                                uint32_t data_length);
289
290 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
291                                         size_t expected_body_size);
292
293 void smb2_request_set_async_internal(struct smbd_smb2_request *req,
294                                      bool async_internal);
295
296 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
297                                                      const int dialect_count,
298                                                      uint16_t *dialect);
299 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
305 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
306 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
307 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
308 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
309 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
310 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
311 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
312                                     int err);
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_query_directory(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 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
322 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
323                                 struct tevent_immediate *im,
324                                 void *private_data);
325
326 struct deferred_open_record;
327
328 /* SMB1 -> SMB2 glue. */
329 void send_break_message_smb2(files_struct *fsp,
330                              uint32_t break_from,
331                              uint32_t break_to);
332 /* From smbd/smb2_create.c */
333 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
334 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
335                         struct timeval *p_request_time,
336                         struct deferred_open_record **open_rec);
337 bool open_was_deferred_smb2(
338         struct smbXsrv_connection *xconn, uint64_t mid);
339 void remove_deferred_open_message_smb2(
340         struct smbXsrv_connection *xconn, uint64_t mid);
341 bool schedule_deferred_open_message_smb2(
342         struct smbXsrv_connection *xconn, uint64_t mid);
343 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
344                                 struct timeval request_time,
345                                 struct timeval timeout,
346                                 struct file_id id,
347                                 struct deferred_open_record *open_rec);
348
349 struct smbXsrv_client;
350
351 struct smbXsrv_preauth {
352         uint8_t sha512_value[64];
353 };
354
355 struct smbXsrv_connection {
356         struct smbXsrv_connection *prev, *next;
357
358         struct smbXsrv_client *client;
359
360         NTTIME connect_time;
361         uint64_t channel_id;
362         const struct tsocket_address *local_address;
363         const struct tsocket_address *remote_address;
364         const char *remote_hostname;
365         bool has_cluster_movable_ip;
366
367         enum protocol_types protocol;
368
369         struct {
370                 NTSTATUS status;
371                 bool terminating;
372                 struct tevent_queue *shutdown_wait_queue;
373                 int sock;
374                 struct tevent_fd *fde;
375
376                 struct {
377                         bool got_session;
378                 } nbt;
379         } transport;
380
381         struct {
382                 bool force_unacked_timeout;
383                 uint64_t unacked_bytes;
384                 uint32_t rto_usecs;
385                 struct tevent_req *checker_subreq;
386                 struct smbd_smb2_send_queue *queue;
387         } ack;
388
389         struct {
390                 struct {
391                         /*
392                          * fd for the fcntl lock and process shared
393                          * robust mutex to coordinate access to the
394                          * client socket. When the system supports
395                          * process shared robust mutexes, those are
396                          * used. If not, then the fcntl lock will be
397                          * used.
398                          */
399                         int socket_lock_fd;
400 #ifdef HAVE_ROBUST_MUTEXES
401                         pthread_mutex_t *socket_mutex;
402 #endif
403
404                         /*
405                          * fd for the trusted pipe from
406                          * echo handler child
407                          */
408                         int trusted_fd;
409
410                         /*
411                          * fde for the trusted_fd
412                          */
413                         struct tevent_fd *trusted_fde;
414
415                         /*
416                          * Reference count for the fcntl lock to
417                          * allow recursive locks.
418                          */
419                         int ref_count;
420                 } echo_handler;
421
422                 struct {
423                         bool encrypted_passwords;
424                         bool spnego;
425                         struct auth4_context *auth_context;
426                         bool done;
427                         /*
428                          * Size of the data we can receive. Set by us.
429                          * Can be modified by the max xmit parameter.
430                          */
431                         int max_recv;
432                 } negprot;
433
434                 struct {
435                         bool done_sesssetup;
436                         /*
437                          * Size of data we can send to client. Set
438                          *  by the client for all protocols above CORE.
439                          *  Set by us for CORE protocol.
440                          */
441                         int max_send;
442                 } sessions;
443                 struct smb_signing_state *signing_state;
444
445                 struct {
446                         uint16_t client_major;
447                         uint16_t client_minor;
448                         uint32_t client_cap_low;
449                         uint32_t client_cap_high;
450                 } unix_info;
451
452                 struct msg_state *msg_state;
453         } smb1;
454         struct {
455                 struct smbd_smb2_request_read_state {
456                         struct smbd_smb2_request *req;
457                         struct {
458                                 uint8_t nbt[NBT_HDR_SIZE];
459                                 bool done;
460                         } hdr;
461                         struct iovec vector;
462                         bool doing_receivefile;
463                         size_t min_recv_size;
464                         size_t pktfull;
465                         size_t pktlen;
466                         uint8_t *pktbuf;
467                 } request_read_state;
468                 struct smbd_smb2_send_queue *send_queue;
469                 size_t send_queue_len;
470
471                 struct {
472                         /*
473                          * seq_low is the lowest sequence number
474                          * we will accept.
475                          */
476                         uint64_t seq_low;
477                         /*
478                          * seq_range is the range of credits we have
479                          * granted from the sequence windows starting
480                          * at seq_low.
481                          *
482                          * This gets incremented when new credits are
483                          * granted and gets decremented when the
484                          * lowest sequence number is consumed
485                          * (when seq_low gets incremented).
486                          */
487                         uint16_t seq_range;
488                         /*
489                          * The number of credits we have currently granted
490                          * to the client.
491                          *
492                          * This gets incremented when new credits are
493                          * granted and gets decremented when any credit
494                          * is comsumed.
495                          *
496                          * Note: the decrementing is different compared
497                          *       to seq_range.
498                          */
499                         uint16_t granted;
500                         /*
501                          * The maximum number of credits we will ever
502                          * grant to the client.
503                          *
504                          * Typically we will only grant 1/16th of
505                          * max_credits.
506                          *
507                          * This is the "server max credits" parameter.
508                          */
509                         uint16_t max;
510                         /*
511                          * a bitmap of size max_credits
512                          */
513                         struct bitmap *bitmap;
514                         bool multicredit;
515                 } credits;
516
517                 bool allow_2ff;
518                 struct {
519                         uint32_t capabilities;
520                         struct GUID guid;
521                         bool guid_verified;
522                         uint16_t security_mode;
523                         uint16_t num_dialects;
524                         uint16_t *dialects;
525                 } client;
526                 struct {
527                         uint32_t capabilities;
528                         struct GUID guid;
529                         uint16_t security_mode;
530                         uint16_t dialect;
531                         uint32_t max_trans;
532                         uint32_t max_read;
533                         uint32_t max_write;
534                         uint16_t sign_algo;
535                         uint16_t cipher;
536                 } server;
537
538                 struct smbXsrv_preauth preauth;
539
540                 struct smbd_smb2_request *requests;
541
542                 struct {
543                         uint8_t read_body_padding;
544                 } smbtorture;
545         } smb2;
546 };
547
548 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
549
550 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
551 uint32_t smbXsrv_version_global_current(void);
552
553 struct smbXsrv_client_table;
554 NTSTATUS smbXsrv_client_global_init(void);
555 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
556                                struct tevent_context *ev_ctx,
557                                struct messaging_context *msg_ctx,
558                                NTTIME now,
559                                struct smbXsrv_client **_client);
560 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
561 struct tevent_req *smb2srv_client_mc_negprot_send(TALLOC_CTX *mem_ctx,
562                                                   struct tevent_context *ev,
563                                                   struct smbd_smb2_request *smb2req);
564 NTSTATUS smb2srv_client_mc_negprot_recv(struct tevent_req *req);
565
566 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
567                                         enum protocol_types protocol);
568
569 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
570 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
571                                 NTTIME now,
572                                 struct smbXsrv_session **_session);
573 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
574                                      struct smbXsrv_connection *conn,
575                                      NTTIME now,
576                                      struct smbXsrv_channel_global0 **_c);
577 NTSTATUS smbXsrv_session_remove_channel(struct smbXsrv_session *session,
578                                         struct smbXsrv_connection *xconn);
579 NTSTATUS smbXsrv_session_disconnect_xconn(struct smbXsrv_connection *xconn);
580 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
581 struct smbXsrv_channel_global0;
582 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
583                                       const struct smbXsrv_connection *conn,
584                                       struct smbXsrv_channel_global0 **_c);
585 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
586                                    const struct smbXsrv_connection *conn,
587                                    NTTIME now,
588                                    struct smbXsrv_session_auth0 **_a);
589 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
590                                      struct smbXsrv_connection *conn,
591                                      NTTIME now,
592                                      uint8_t in_flags,
593                                      uint8_t in_security_mode,
594                                      struct smbXsrv_session_auth0 **_a);
595 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
596                                         struct tevent_context *ev,
597                                         struct smbXsrv_session *session,
598                                         struct smbd_smb2_request *current_req);
599 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
600 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
601 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_client *client);
602 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
603 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
604                                 uint16_t vuid, NTTIME now,
605                                 struct smbXsrv_session **session);
606 NTSTATUS smbXsrv_session_info_lookup(struct smbXsrv_client *client,
607                                      uint64_t session_wire_id,
608                                      struct auth_session_info **si);
609 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
610 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
611                                      uint64_t session_id, NTTIME now,
612                                      struct smbXsrv_session **session);
613 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
614                                        uint64_t session_id, NTTIME now,
615                                        struct smbXsrv_session **session);
616 NTSTATUS smb2srv_session_lookup_global(struct smbXsrv_client *client,
617                                        uint64_t session_wire_id,
618                                        TALLOC_CTX *mem_ctx,
619                                        struct smbXsrv_session **session);
620 NTSTATUS get_valid_smbXsrv_session(struct smbXsrv_client *client,
621                                    uint64_t session_wire_id,
622                                    struct smbXsrv_session **session);
623 NTSTATUS smbXsrv_session_local_traverse(
624         struct smbXsrv_client *client,
625         int (*caller_cb)(struct smbXsrv_session *session,
626                               void *caller_data),
627         void *caller_data);
628 struct smbXsrv_session_global0;
629 NTSTATUS smbXsrv_session_global_traverse(
630                         int (*fn)(struct smbXsrv_session_global0 *, void *),
631                         void *private_data);
632 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
633                                         struct tevent_context *ev,
634                                         struct smbXsrv_connection *conn,
635                                         struct auth_session_info *session_info,
636                                         uint64_t previous_session_id,
637                                         uint64_t current_session_id);
638 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
639
640 NTSTATUS smbXsrv_tcon_global_init(void);
641 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
642 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
643 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
644 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
645                              NTTIME now,
646                              struct smbXsrv_tcon **_tcon);
647 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
648                              uint16_t tree_id, NTTIME now,
649                              struct smbXsrv_tcon **tcon);
650 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_client *client);
651 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
652 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
653                              NTTIME now,
654                              struct smbXsrv_tcon **_tcon);
655 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
656                              uint32_t tree_id, NTTIME now,
657                              struct smbXsrv_tcon **tcon);
658 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
659 struct smbXsrv_tcon_global0;
660 NTSTATUS smbXsrv_tcon_global_traverse(
661                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
662                         void *private_data);
663
664 NTSTATUS smbXsrv_open_global_init(void);
665 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
666                              struct auth_session_info *session_info,
667                              NTTIME now,
668                              struct smbXsrv_open **_open);
669 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
670 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
671 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
672 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
673                              uint16_t fnum, NTTIME now,
674                              struct smbXsrv_open **_open);
675 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
676 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
677                              uint64_t persistent_id,
678                              uint64_t volatile_id,
679                              NTTIME now,
680                              struct smbXsrv_open **_open);
681 NTSTATUS smbXsrv_open_purge_replay_cache(struct smbXsrv_client *client,
682                                          const struct GUID *create_guid);
683 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
684                                           struct GUID caller_req_guid,
685                                           struct GUID create_guid,
686                                           const char *name,
687                                           NTTIME now,
688                                           struct smbXsrv_open **_open);
689 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
690                                struct auth_session_info *session_info,
691                                uint64_t persistent_id,
692                                const struct GUID *create_guid,
693                                NTTIME now,
694                                struct smbXsrv_open **_open);
695 struct smbXsrv_open_global0;
696 NTSTATUS smbXsrv_open_global_traverse(
697         int (*fn)(struct smbXsrv_open_global0 *, void *),
698         void *private_data);
699
700 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
701 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
702 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
703 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
704 bool smbXsrv_is_signed(uint8_t signing_flags);
705 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
706
707 struct smbd_smb2_send_queue {
708         struct smbd_smb2_send_queue *prev, *next;
709
710         DATA_BLOB *sendfile_header;
711         uint32_t sendfile_body_size;
712         NTSTATUS *sendfile_status;
713         struct iovec *vector;
714         int count;
715
716         struct {
717                 struct tevent_req *req;
718                 struct timeval timeout;
719                 uint64_t required_acked_bytes;
720         } ack;
721
722         TALLOC_CTX *mem_ctx;
723 };
724
725 struct smbd_smb2_request {
726         struct smbd_smb2_request *prev, *next;
727
728         struct smbd_server_connection *sconn;
729         struct smbXsrv_connection *xconn;
730
731         struct smbd_smb2_send_queue queue_entry;
732
733         /* the session the request operates on, maybe NULL */
734         struct smbXsrv_session *session;
735         uint64_t last_session_id;
736
737         /* the tcon the request operates on, maybe NULL */
738         struct smbXsrv_tcon *tcon;
739         uint32_t last_tid;
740
741         int current_idx;
742         bool do_signing;
743         /* Was the request encrypted? */
744         bool was_encrypted;
745         /* Should we encrypt? */
746         bool do_encryption;
747         struct tevent_timer *async_te;
748         bool compound_related;
749         NTSTATUS compound_create_err;
750
751         /*
752          * Give the implementation of an SMB2 req a way to tell the SMB2 request
753          * processing engine that the internal request is going async, while
754          * preserving synchronous SMB2 behaviour.
755          */
756         bool async_internal;
757
758         /*
759          * the encryption key for the whole
760          * compound chain
761          */
762         struct smb2_signing_key *first_enc_key;
763         /*
764          * the signing key for the last
765          * request/response of a compound chain
766          */
767         struct smb2_signing_key *last_sign_key;
768         struct smbXsrv_preauth *preauth;
769
770         struct timeval request_time;
771
772         SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
773
774         /* fake smb1 request. */
775         struct smb_request *smb1req;
776         struct files_struct *compat_chain_fsp;
777
778         /*
779          * Keep track of whether the outstanding request counters
780          * had been updated in dispatch, so that they need to be
781          * adapted again in reply.
782          */
783         bool request_counters_updated;
784         uint64_t channel_generation;
785
786         /*
787          * The sub request for async backend calls.
788          * This is used for SMB2 Cancel.
789          */
790         struct tevent_req *subreq;
791
792 #define SMBD_SMB2_TF_IOV_OFS 0
793 #define SMBD_SMB2_HDR_IOV_OFS 1
794 #define SMBD_SMB2_BODY_IOV_OFS 2
795 #define SMBD_SMB2_DYN_IOV_OFS 3
796
797 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
798
799 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
800         (&req->dir.vector[(idx)+(ofs)])
801
802 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
803         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
804 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
805         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
806 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
807         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
808 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
809         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
810
811 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
812 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
813 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
814 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
815 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
816 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
817 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
818 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
819 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
820 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
821
822 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
823 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
824 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
825 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
826 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
827 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
828 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
829 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
830 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
831 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
832
833 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
834
835         struct {
836                 /*
837                  * vector[0] TRANSPORT HEADER (empty)
838                  * .
839                  * vector[1] SMB2_TRANSFORM (optional)
840                  * vector[2] SMB2
841                  * vector[3] fixed body
842                  * vector[4] dynamic body
843                  * .
844                  * .
845                  * .
846                  * vector[5] SMB2_TRANSFORM (optional)
847                  * vector[6] SMB2
848                  * vector[7] fixed body
849                  * vector[8] dynamic body
850                  * .
851                  * .
852                  * .
853                  */
854                 struct iovec *vector;
855                 int vector_count;
856                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
857         } in;
858         struct {
859                 /* the NBT header is not allocated */
860                 uint8_t nbt_hdr[4];
861                 /*
862                  * vector[0] TRANSPORT HEADER
863                  * .
864                  * vector[1] SMB2_TRANSFORM (optional)
865                  * vector[2] SMB2
866                  * vector[3] fixed body
867                  * vector[4] dynamic body
868                  * .
869                  * .
870                  * .
871                  * vector[5] SMB2_TRANSFORM (empty)
872                  * vector[6] SMB2
873                  * vector[7] fixed body
874                  * vector[8] dynamic body
875                  * .
876                  * .
877                  * .
878                  */
879                 struct iovec *vector;
880                 int vector_count;
881                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
882 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
883                 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
884                 uint8_t _body[0x58];
885         } out;
886 };
887
888 struct smbd_server_connection;
889
890 struct pending_message_list;
891 struct pending_auth_data;
892
893 struct pthreadpool_tevent;
894 struct dcesrv_context;
895
896 struct smbd_server_connection {
897         const struct tsocket_address *local_address;
898         const struct tsocket_address *remote_address;
899         const char *remote_hostname;
900         struct tevent_context *ev_ctx;
901         struct messaging_context *msg_ctx;
902         struct dcesrv_context *dce_ctx;
903         struct notify_context *notify_ctx;
904         bool using_smb2;
905         int trans_num;
906
907         size_t num_users;
908
909         size_t num_connections;
910         struct connection_struct *connections;
911
912         size_t num_files;
913         struct files_struct *files;
914
915         int real_max_open_files;
916         struct fsp_singleton_cache fsp_fi_cache;
917
918         struct pending_message_list *deferred_open_queue;
919
920
921         /* open directory handles. */
922         struct {
923                 struct bitmap *dptr_bmap;
924                 struct dptr_struct *dirptrs;
925         } searches;
926
927         uint64_t num_requests;
928
929         /* Current number of oplocks we have outstanding. */
930         struct {
931                 int32_t exclusive_open;
932                 int32_t level_II_open;
933                 struct kernel_oplocks *kernel_ops;
934         } oplocks;
935
936         struct {
937                 struct notify_mid_map *notify_mid_maps;
938         } smb1;
939
940         struct pthreadpool_tevent *pool;
941
942         struct smbXsrv_client *client;
943 };
944
945 extern struct smbXsrv_client *global_smbXsrv_client;
946
947 void smbd_init_globals(void);
948
949 #endif /* _SOURCE3_SMBD_GLOBALS_H_ */