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