176c9053f3a42ed56a97879e836d714de8f8b574
[vlendec/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                 uint64_t unacked_bytes;
379                 uint32_t rto_usecs;
380                 struct tevent_req *checker_subreq;
381                 struct smbd_smb2_send_queue *queue;
382         } ack;
383
384         struct {
385                 struct {
386                         /*
387                          * fd for the fcntl lock and process shared
388                          * robust mutex to coordinate access to the
389                          * client socket. When the system supports
390                          * process shared robust mutexes, those are
391                          * used. If not, then the fcntl lock will be
392                          * used.
393                          */
394                         int socket_lock_fd;
395 #ifdef HAVE_ROBUST_MUTEXES
396                         pthread_mutex_t *socket_mutex;
397 #endif
398
399                         /*
400                          * fd for the trusted pipe from
401                          * echo handler child
402                          */
403                         int trusted_fd;
404
405                         /*
406                          * fde for the trusted_fd
407                          */
408                         struct tevent_fd *trusted_fde;
409
410                         /*
411                          * Reference count for the fcntl lock to
412                          * allow recursive locks.
413                          */
414                         int ref_count;
415                 } echo_handler;
416
417                 struct {
418                         bool encrypted_passwords;
419                         bool spnego;
420                         struct auth4_context *auth_context;
421                         bool done;
422                         /*
423                          * Size of the data we can receive. Set by us.
424                          * Can be modified by the max xmit parameter.
425                          */
426                         int max_recv;
427                 } negprot;
428
429                 struct {
430                         bool done_sesssetup;
431                         /*
432                          * Size of data we can send to client. Set
433                          *  by the client for all protocols above CORE.
434                          *  Set by us for CORE protocol.
435                          */
436                         int max_send;
437                 } sessions;
438                 struct smb_signing_state *signing_state;
439
440                 struct {
441                         uint16_t client_major;
442                         uint16_t client_minor;
443                         uint32_t client_cap_low;
444                         uint32_t client_cap_high;
445                 } unix_info;
446
447                 struct msg_state *msg_state;
448         } smb1;
449         struct {
450                 struct smbd_smb2_request_read_state {
451                         struct smbd_smb2_request *req;
452                         struct {
453                                 uint8_t nbt[NBT_HDR_SIZE];
454                                 bool done;
455                         } hdr;
456                         struct iovec vector;
457                         bool doing_receivefile;
458                         size_t min_recv_size;
459                         size_t pktfull;
460                         size_t pktlen;
461                         uint8_t *pktbuf;
462                 } request_read_state;
463                 struct smbd_smb2_send_queue *send_queue;
464                 size_t send_queue_len;
465
466                 struct {
467                         /*
468                          * seq_low is the lowest sequence number
469                          * we will accept.
470                          */
471                         uint64_t seq_low;
472                         /*
473                          * seq_range is the range of credits we have
474                          * granted from the sequence windows starting
475                          * at seq_low.
476                          *
477                          * This gets incremented when new credits are
478                          * granted and gets decremented when the
479                          * lowest sequence number is consumed
480                          * (when seq_low gets incremented).
481                          */
482                         uint16_t seq_range;
483                         /*
484                          * The number of credits we have currently granted
485                          * to the client.
486                          *
487                          * This gets incremented when new credits are
488                          * granted and gets decremented when any credit
489                          * is comsumed.
490                          *
491                          * Note: the decrementing is different compared
492                          *       to seq_range.
493                          */
494                         uint16_t granted;
495                         /*
496                          * The maximum number of credits we will ever
497                          * grant to the client.
498                          *
499                          * Typically we will only grant 1/16th of
500                          * max_credits.
501                          *
502                          * This is the "server max credits" parameter.
503                          */
504                         uint16_t max;
505                         /*
506                          * a bitmap of size max_credits
507                          */
508                         struct bitmap *bitmap;
509                         bool multicredit;
510                 } credits;
511
512                 bool allow_2ff;
513                 struct {
514                         uint32_t capabilities;
515                         struct GUID guid;
516                         bool guid_verified;
517                         uint16_t security_mode;
518                         uint16_t num_dialects;
519                         uint16_t *dialects;
520                 } client;
521                 struct {
522                         uint32_t capabilities;
523                         struct GUID guid;
524                         uint16_t security_mode;
525                         uint16_t dialect;
526                         uint32_t max_trans;
527                         uint32_t max_read;
528                         uint32_t max_write;
529                         uint16_t cipher;
530                 } server;
531
532                 struct smbXsrv_preauth preauth;
533
534                 struct smbd_smb2_request *requests;
535         } smb2;
536 };
537
538 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
539
540 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
541 uint32_t smbXsrv_version_global_current(void);
542
543 struct smbXsrv_client_table;
544 NTSTATUS smbXsrv_client_global_init(void);
545 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
546                                struct tevent_context *ev_ctx,
547                                struct messaging_context *msg_ctx,
548                                NTTIME now,
549                                struct smbXsrv_client **_client);
550 NTSTATUS smbXsrv_client_update(struct smbXsrv_client *client);
551 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
552 NTSTATUS smb2srv_client_lookup_global(struct smbXsrv_client *client,
553                                       struct GUID client_guid,
554                                       TALLOC_CTX *mem_ctx,
555                                       struct smbXsrv_client_global0 **_pass);
556 NTSTATUS smb2srv_client_connection_pass(struct smbd_smb2_request *smb2req,
557                                         struct smbXsrv_client_global0 *global);
558
559 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
560                                         enum protocol_types protocol);
561
562 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
563 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
564                                 NTTIME now,
565                                 struct smbXsrv_session **_session);
566 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
567                                      struct smbXsrv_connection *conn,
568                                      NTTIME now,
569                                      struct smbXsrv_channel_global0 **_c);
570 NTSTATUS smbXsrv_session_disconnect_xconn(struct smbXsrv_connection *xconn);
571 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
572 struct smbXsrv_channel_global0;
573 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
574                                       const struct smbXsrv_connection *conn,
575                                       struct smbXsrv_channel_global0 **_c);
576 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
577                                    const struct smbXsrv_connection *conn,
578                                    NTTIME now,
579                                    struct smbXsrv_session_auth0 **_a);
580 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
581                                      struct smbXsrv_connection *conn,
582                                      NTTIME now,
583                                      uint8_t in_flags,
584                                      uint8_t in_security_mode,
585                                      struct smbXsrv_session_auth0 **_a);
586 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
587                                         struct tevent_context *ev,
588                                         struct smbXsrv_session *session,
589                                         struct smbd_smb2_request *current_req);
590 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
591 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
592 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_client *client);
593 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
594 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
595                                 uint16_t vuid, NTTIME now,
596                                 struct smbXsrv_session **session);
597 NTSTATUS smbXsrv_session_info_lookup(struct smbXsrv_client *client,
598                                      uint64_t session_wire_id,
599                                      struct auth_session_info **si);
600 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
601 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
602                                      uint64_t session_id, NTTIME now,
603                                      struct smbXsrv_session **session);
604 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
605                                        uint64_t session_id, NTTIME now,
606                                        struct smbXsrv_session **session);
607 NTSTATUS get_valid_smbXsrv_session(struct smbXsrv_client *client,
608                                    uint64_t session_wire_id,
609                                    struct smbXsrv_session **session);
610 NTSTATUS smbXsrv_session_local_traverse(
611         struct smbXsrv_client *client,
612         int (*caller_cb)(struct smbXsrv_session *session,
613                               void *caller_data),
614         void *caller_data);
615 struct smbXsrv_session_global0;
616 NTSTATUS smbXsrv_session_global_traverse(
617                         int (*fn)(struct smbXsrv_session_global0 *, void *),
618                         void *private_data);
619 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
620                                         struct tevent_context *ev,
621                                         struct smbXsrv_connection *conn,
622                                         struct auth_session_info *session_info,
623                                         uint64_t previous_session_id,
624                                         uint64_t current_session_id);
625 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
626
627 NTSTATUS smbXsrv_tcon_global_init(void);
628 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
629 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
630 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
631 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
632                              NTTIME now,
633                              struct smbXsrv_tcon **_tcon);
634 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
635                              uint16_t tree_id, NTTIME now,
636                              struct smbXsrv_tcon **tcon);
637 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_client *client);
638 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
639 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
640                              NTTIME now,
641                              struct smbXsrv_tcon **_tcon);
642 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
643                              uint32_t tree_id, NTTIME now,
644                              struct smbXsrv_tcon **tcon);
645 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
646 struct smbXsrv_tcon_global0;
647 NTSTATUS smbXsrv_tcon_global_traverse(
648                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
649                         void *private_data);
650
651 NTSTATUS smbXsrv_open_global_init(void);
652 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
653                              struct auth_session_info *session_info,
654                              NTTIME now,
655                              struct smbXsrv_open **_open);
656 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
657 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
658 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
659 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
660                              uint16_t fnum, NTTIME now,
661                              struct smbXsrv_open **_open);
662 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
663 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
664                              uint64_t persistent_id,
665                              uint64_t volatile_id,
666                              NTTIME now,
667                              struct smbXsrv_open **_open);
668 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
669                                           const struct GUID *create_guid,
670                                           NTTIME now,
671                                           struct smbXsrv_open **_open);
672 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
673                                struct auth_session_info *session_info,
674                                uint64_t persistent_id,
675                                const struct GUID *create_guid,
676                                NTTIME now,
677                                struct smbXsrv_open **_open);
678 struct smbXsrv_open_global0;
679 NTSTATUS smbXsrv_open_global_traverse(
680         int (*fn)(struct smbXsrv_open_global0 *, void *),
681         void *private_data);
682
683 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
684 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
685 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
686 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
687 bool smbXsrv_is_signed(uint8_t signing_flags);
688 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
689
690 struct smbd_smb2_send_queue {
691         struct smbd_smb2_send_queue *prev, *next;
692
693         DATA_BLOB *sendfile_header;
694         uint32_t sendfile_body_size;
695         NTSTATUS *sendfile_status;
696         struct iovec *vector;
697         int count;
698
699         struct {
700                 struct tevent_req *req;
701                 struct timeval timeout;
702                 uint64_t required_acked_bytes;
703         } ack;
704
705         TALLOC_CTX *mem_ctx;
706 };
707
708 struct smbd_smb2_request {
709         struct smbd_smb2_request *prev, *next;
710
711         struct smbd_server_connection *sconn;
712         struct smbXsrv_connection *xconn;
713
714         struct smbd_smb2_send_queue queue_entry;
715
716         /* the session the request operates on, maybe NULL */
717         struct smbXsrv_session *session;
718         uint64_t last_session_id;
719
720         /* the tcon the request operates on, maybe NULL */
721         struct smbXsrv_tcon *tcon;
722         uint32_t last_tid;
723
724         int current_idx;
725         bool do_signing;
726         /* Was the request encrypted? */
727         bool was_encrypted;
728         /* Should we encrypt? */
729         bool do_encryption;
730         struct tevent_timer *async_te;
731         bool compound_related;
732
733         /*
734          * Give the implementation of an SMB2 req a way to tell the SMB2 request
735          * processing engine that the internal request is going async, while
736          * preserving synchronous SMB2 behaviour.
737          */
738         bool async_internal;
739
740         /*
741          * the encryption key for the whole
742          * compound chain
743          */
744         DATA_BLOB first_key;
745         /*
746          * the signing key for the last
747          * request/response of a compound chain
748          */
749         DATA_BLOB last_key;
750         struct smbXsrv_preauth *preauth;
751
752         struct timeval request_time;
753
754         SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
755
756         /* fake smb1 request. */
757         struct smb_request *smb1req;
758         struct files_struct *compat_chain_fsp;
759
760         /*
761          * Keep track of whether the outstanding request counters
762          * had been updated in dispatch, so that they need to be
763          * adapted again in reply.
764          */
765         bool request_counters_updated;
766         uint64_t channel_generation;
767
768         /*
769          * The sub request for async backend calls.
770          * This is used for SMB2 Cancel.
771          */
772         struct tevent_req *subreq;
773
774 #define SMBD_SMB2_TF_IOV_OFS 0
775 #define SMBD_SMB2_HDR_IOV_OFS 1
776 #define SMBD_SMB2_BODY_IOV_OFS 2
777 #define SMBD_SMB2_DYN_IOV_OFS 3
778
779 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
780
781 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
782         (&req->dir.vector[(idx)+(ofs)])
783
784 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
785         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
786 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
787         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
788 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
789         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
790 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
791         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
792
793 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
794 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
795 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
796 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
797 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
798 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
799 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
800 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
801 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
802 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
803
804 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
805 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
806 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
807 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
808 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
809 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
810 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
811 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
812 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
813 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
814
815 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
816
817         struct {
818                 /*
819                  * vector[0] TRANSPORT HEADER (empty)
820                  * .
821                  * vector[1] SMB2_TRANSFORM (optional)
822                  * vector[2] SMB2
823                  * vector[3] fixed body
824                  * vector[4] dynamic body
825                  * .
826                  * .
827                  * .
828                  * vector[5] SMB2_TRANSFORM (optional)
829                  * vector[6] SMB2
830                  * vector[7] fixed body
831                  * vector[8] dynamic body
832                  * .
833                  * .
834                  * .
835                  */
836                 struct iovec *vector;
837                 int vector_count;
838                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
839         } in;
840         struct {
841                 /* the NBT header is not allocated */
842                 uint8_t nbt_hdr[4];
843                 /*
844                  * vector[0] TRANSPORT HEADER
845                  * .
846                  * vector[1] SMB2_TRANSFORM (optional)
847                  * vector[2] SMB2
848                  * vector[3] fixed body
849                  * vector[4] dynamic body
850                  * .
851                  * .
852                  * .
853                  * vector[5] SMB2_TRANSFORM (empty)
854                  * vector[6] SMB2
855                  * vector[7] fixed body
856                  * vector[8] dynamic body
857                  * .
858                  * .
859                  * .
860                  */
861                 struct iovec *vector;
862                 int vector_count;
863                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
864 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
865                 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
866                 uint8_t _body[0x58];
867         } out;
868 };
869
870 struct smbd_server_connection;
871
872 struct pending_message_list;
873 struct pending_auth_data;
874
875 struct pthreadpool_tevent;
876 struct dcesrv_context;
877
878 struct smbd_server_connection {
879         const struct tsocket_address *local_address;
880         const struct tsocket_address *remote_address;
881         const char *remote_hostname;
882         struct tevent_context *ev_ctx;
883         struct messaging_context *msg_ctx;
884         struct dcesrv_context *dce_ctx;
885         struct notify_context *notify_ctx;
886         bool using_smb2;
887         int trans_num;
888
889         size_t num_users;
890
891         size_t num_connections;
892         struct connection_struct *connections;
893
894         size_t num_files;
895         struct files_struct *files;
896
897         int real_max_open_files;
898         struct fsp_singleton_cache fsp_fi_cache;
899
900         struct pending_message_list *deferred_open_queue;
901
902
903         /* open directory handles. */
904         struct {
905                 struct bitmap *dptr_bmap;
906                 struct dptr_struct *dirptrs;
907         } searches;
908
909         uint64_t num_requests;
910
911         /* Current number of oplocks we have outstanding. */
912         struct {
913                 int32_t exclusive_open;
914                 int32_t level_II_open;
915                 struct kernel_oplocks *kernel_ops;
916         } oplocks;
917
918         struct {
919                 struct notify_mid_map *notify_mid_maps;
920         } smb1;
921
922         struct pthreadpool_tevent *pool;
923
924         struct smbXsrv_client *client;
925 };
926
927 extern struct smbXsrv_client *global_smbXsrv_client;
928
929 void smbd_init_globals(void);
930
931 #endif /* _SOURCE3_SMBD_GLOBALS_H_ */