smbd: add zero_file_id flag
[kai/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 #include "system/select.h"
22 #include "librpc/gen_ndr/smbXsrv.h"
23 #include "smbprofile.h"
24
25 #ifdef USE_DMAPI
26 struct smbd_dmapi_context;
27 extern struct smbd_dmapi_context *dmapi_ctx;
28 #endif
29
30 /* how many write cache buffers have been allocated */
31 extern unsigned int allocated_write_caches;
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 };
93 /* A stack of current_user connection contexts. */
94 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
95 extern int conn_ctx_stack_ndx;
96
97 struct vfs_init_function_entry;
98 extern struct vfs_init_function_entry *backends;
99 extern char *sparse_buf;
100 extern char *LastDir;
101
102 struct smbd_parent_context;
103 extern struct smbd_parent_context *am_parent;
104 extern struct memcache *smbd_memcache_ctx;
105 extern bool exit_firsttime;
106
107 struct tstream_context;
108 struct smbd_smb2_request;
109
110 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbXsrv_connection *xconn);
111
112 void smbd_lock_socket(struct smbXsrv_connection *xconn);
113 void smbd_unlock_socket(struct smbXsrv_connection *xconn);
114
115 NTSTATUS smbd_do_locking(struct smb_request *req,
116                          files_struct *fsp,
117                          uint8_t type,
118                          int32_t timeout,
119                          uint16_t num_locks,
120                          struct smbd_lock_element *locks,
121                          bool *async);
122 NTSTATUS smbd_do_unlocking(struct smb_request *req,
123                            files_struct *fsp,
124                            uint16_t num_ulocks,
125                            struct smbd_lock_element *ulocks);
126
127 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
128                                TALLOC_CTX *mem_ctx,
129                                uint16_t info_level,
130                                files_struct *fsp,
131                                struct smb_filename *smb_fname,
132                                bool delete_pending,
133                                struct timespec write_time_ts,
134                                struct ea_list *ea_list,
135                                int lock_data_count,
136                                char *lock_data,
137                                uint16_t flags2,
138                                unsigned int max_data_bytes,
139                                size_t *fixed_portion,
140                                char **ppdata,
141                                unsigned int *pdata_size);
142
143 NTSTATUS smbd_do_setfsinfo(connection_struct *conn,
144                                 struct smb_request *req,
145                                 TALLOC_CTX *mem_ctx,
146                                 uint16_t info_level,
147                                 files_struct *fsp,
148                                 const DATA_BLOB *pdata);
149
150 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
151                                 struct smb_request *req,
152                                 TALLOC_CTX *mem_ctx,
153                                 uint16_t info_level,
154                                 files_struct *fsp,
155                                 struct smb_filename *smb_fname,
156                                 char **ppdata, int total_data,
157                                 int *ret_data_size);
158
159 NTSTATUS smbd_do_qfsinfo(struct smbXsrv_connection *xconn,
160                          connection_struct *conn,
161                          TALLOC_CTX *mem_ctx,
162                          uint16_t info_level,
163                          uint16_t flags2,
164                          unsigned int max_data_bytes,
165                          size_t *fixed_portion,
166                          struct smb_filename *smb_fname,
167                          char **ppdata,
168                          int *ret_data_len);
169
170 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
171                            struct dptr_struct *dirptr,
172                            const char *mask,
173                            uint32_t dirtype,
174                            bool dont_descend,
175                            bool ask_sharemode,
176                            bool (*match_fn)(TALLOC_CTX *ctx,
177                                             void *private_data,
178                                             const char *dname,
179                                             const char *mask,
180                                             char **_fname),
181                            bool (*mode_fn)(TALLOC_CTX *ctx,
182                                            void *private_data,
183                                            struct smb_filename *smb_fname,
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                                uint8_t align,
202                                bool do_pad,
203                                char **ppdata,
204                                char *base_data,
205                                char *end_data,
206                                int space_remaining,
207                                bool *got_exact_match,
208                                int *_last_entry_off,
209                                struct ea_list *name_list);
210
211 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
212                                     const struct smb_filename *smb_fname,
213                                     bool use_privs,
214                                     uint32_t access_mask,
215                                     uint32_t *access_mask_out);
216
217 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
218
219 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
220                                          const char *reason,
221                                          const char *location);
222 #define smbd_server_connection_terminate(xconn, reason) \
223         smbd_server_connection_terminate_ex(xconn, reason, __location__)
224
225 const char *smb2_opcode_name(uint16_t opcode);
226 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
227
228 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
229                              struct smbXsrv_connection **_xconn);
230
231 void reply_smb2002(struct smb_request *req, uint16_t choice);
232 void reply_smb20ff(struct smb_request *req, uint16_t choice);
233 void smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
234                                uint64_t expected_seq_low,
235                                const uint8_t *inpdu, size_t size);
236
237 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
238
239 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
240                                     NTSTATUS status,
241                                     DATA_BLOB *info,
242                                     const char *location);
243 #define smbd_smb2_request_error(req, status) \
244         smbd_smb2_request_error_ex(req, status, NULL, __location__)
245 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
246                                    NTSTATUS status,
247                                    DATA_BLOB body, DATA_BLOB *dyn,
248                                    const char *location);
249 #define smbd_smb2_request_done(req, body, dyn) \
250         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
251
252 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_connection *xconn,
253                                      struct smbXsrv_session *session,
254                                      struct smbXsrv_tcon *tcon,
255                                      struct smbXsrv_open *op,
256                                      uint8_t oplock_level);
257 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_connection *xconn,
258                                     uint16_t new_epoch,
259                                     uint32_t lease_flags,
260                                     struct smb2_lease_key *lease_key,
261                                     uint32_t current_lease_state,
262                                     uint32_t new_lease_state);
263
264 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
265                                          struct tevent_req *subreq,
266                                          uint32_t defer_time);
267
268 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
269 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
270 void remove_smb2_chained_fsp(files_struct *fsp);
271
272 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
273                                                uint32_t data_length);
274
275 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
276                                         size_t expected_body_size);
277
278 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
279                                                      const int dialect_count,
280                                                      uint16_t *dialect);
281 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
282 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
290 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
291 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
292 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
293 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
294                                     int err);
295 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
296 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
297 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
298 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
304 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
305                                 struct tevent_immediate *im,
306                                 void *private_data);
307
308 struct deferred_open_record;
309
310 /* SMB1 -> SMB2 glue. */
311 void send_break_message_smb2(files_struct *fsp,
312                              uint32_t break_from,
313                              uint32_t break_to);
314 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
315 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
316                                 struct smb_request *req,
317                                 files_struct *fsp,
318                                 int lock_timeout,
319                                 int lock_num,
320                                 uint64_t smblctx,
321                                 enum brl_type lock_type,
322                                 enum brl_flavour lock_flav,
323                                 uint64_t offset,
324                                 uint64_t count,
325                                 uint64_t blocking_smblctx);
326 void process_blocking_lock_queue_smb2(
327         struct smbd_server_connection *sconn, struct timeval tv_curr);
328 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
329                         struct byte_range_lock *br_lck,
330                         enum file_close_type close_type);
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
360         const struct tsocket_address *local_address;
361         const struct tsocket_address *remote_address;
362         const char *remote_hostname;
363
364         struct tevent_context *ev_ctx;
365         struct messaging_context *msg_ctx;
366
367         enum protocol_types protocol;
368
369         struct {
370                 NTSTATUS status;
371                 int sock;
372                 struct tevent_fd *fde;
373
374                 struct {
375                         bool got_session;
376                 } nbt;
377         } transport;
378
379         struct {
380                 struct {
381                         /*
382                          * fd for the fcntl lock and process shared
383                          * robust mutex to coordinate access to the
384                          * client socket. When the system supports
385                          * process shared robust mutexes, those are
386                          * used. If not, then the fcntl lock will be
387                          * used.
388                          */
389                         int socket_lock_fd;
390 #ifdef HAVE_ROBUST_MUTEXES
391                         pthread_mutex_t *socket_mutex;
392 #endif
393
394                         /*
395                          * fd for the trusted pipe from
396                          * echo handler child
397                          */
398                         int trusted_fd;
399
400                         /*
401                          * fde for the trusted_fd
402                          */
403                         struct tevent_fd *trusted_fde;
404
405                         /*
406                          * Reference count for the fcntl lock to
407                          * allow recursive locks.
408                          */
409                         int ref_count;
410                 } echo_handler;
411
412                 struct {
413                         bool encrypted_passwords;
414                         bool spnego;
415                         struct auth4_context *auth_context;
416                         bool done;
417                         /*
418                          * Size of the data we can receive. Set by us.
419                          * Can be modified by the max xmit parameter.
420                          */
421                         int max_recv;
422                 } negprot;
423
424                 struct {
425                         bool done_sesssetup;
426                         /*
427                          * Size of data we can send to client. Set
428                          *  by the client for all protocols above CORE.
429                          *  Set by us for CORE protocol.
430                          */
431                         int max_send;
432                 } sessions;
433                 struct smb_signing_state *signing_state;
434
435                 struct {
436                         uint16_t client_major;
437                         uint16_t client_minor;
438                         uint32_t client_cap_low;
439                         uint32_t client_cap_high;
440                 } unix_info;
441
442                 struct msg_state *msg_state;
443         } smb1;
444         struct {
445                 struct smbd_smb2_request_read_state {
446                         struct smbd_smb2_request *req;
447                         struct {
448                                 uint8_t nbt[NBT_HDR_SIZE];
449                                 bool done;
450                         } hdr;
451                         struct iovec vector;
452                         bool doing_receivefile;
453                         size_t min_recv_size;
454                         size_t pktfull;
455                         size_t pktlen;
456                         uint8_t *pktbuf;
457                 } request_read_state;
458                 struct smbd_smb2_send_queue *send_queue;
459                 size_t send_queue_len;
460
461                 struct {
462                         /*
463                          * seq_low is the lowest sequence number
464                          * we will accept.
465                          */
466                         uint64_t seq_low;
467                         /*
468                          * seq_range is the range of credits we have
469                          * granted from the sequence windows starting
470                          * at seq_low.
471                          *
472                          * This gets incremented when new credits are
473                          * granted and gets decremented when the
474                          * lowest sequence number is consumed
475                          * (when seq_low gets incremented).
476                          */
477                         uint16_t seq_range;
478                         /*
479                          * The number of credits we have currently granted
480                          * to the client.
481                          *
482                          * This gets incremented when new credits are
483                          * granted and gets decremented when any credit
484                          * is comsumed.
485                          *
486                          * Note: the decrementing is different compared
487                          *       to seq_range.
488                          */
489                         uint16_t granted;
490                         /*
491                          * The maximum number of credits we will ever
492                          * grant to the client.
493                          *
494                          * Typically we will only grant 1/16th of
495                          * max_credits.
496                          *
497                          * This is the "server max credits" parameter.
498                          */
499                         uint16_t max;
500                         /*
501                          * a bitmap of size max_credits
502                          */
503                         struct bitmap *bitmap;
504                         bool multicredit;
505                 } credits;
506
507                 bool allow_2ff;
508                 struct {
509                         uint32_t capabilities;
510                         struct GUID guid;
511                         bool guid_verified;
512                         uint16_t security_mode;
513                         uint16_t num_dialects;
514                         uint16_t *dialects;
515                 } client;
516                 struct {
517                         uint32_t capabilities;
518                         struct GUID guid;
519                         uint16_t security_mode;
520                         uint16_t dialect;
521                         uint32_t max_trans;
522                         uint32_t max_read;
523                         uint32_t max_write;
524                         uint16_t cipher;
525                 } server;
526
527                 struct smbXsrv_preauth preauth;
528
529                 struct smbd_smb2_request *requests;
530         } smb2;
531 };
532
533 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
534
535 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
536 uint32_t smbXsrv_version_global_current(void);
537
538 struct smbXsrv_client_table;
539 NTSTATUS smbXsrv_client_global_init(void);
540 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
541                                struct tevent_context *ev_ctx,
542                                struct messaging_context *msg_ctx,
543                                NTTIME now,
544                                struct smbXsrv_client **_client);
545 NTSTATUS smbXsrv_client_update(struct smbXsrv_client *client);
546 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
547 NTSTATUS smb2srv_client_lookup_global(struct smbXsrv_client *client,
548                                       struct GUID client_guid,
549                                       TALLOC_CTX *mem_ctx,
550                                       struct smbXsrv_client_global0 **_pass);
551 NTSTATUS smb2srv_client_connection_pass(struct smbd_smb2_request *smb2req,
552                                         struct smbXsrv_client_global0 *global);
553
554 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
555                                         enum protocol_types protocol);
556
557 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
558 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
559                                 NTTIME now,
560                                 struct smbXsrv_session **_session);
561 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
562                                      struct smbXsrv_connection *conn,
563                                      struct smbXsrv_channel_global0 **_c);
564 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
565 struct smbXsrv_channel_global0;
566 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
567                                       const struct smbXsrv_connection *conn,
568                                       struct smbXsrv_channel_global0 **_c);
569 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
570                                    const struct smbXsrv_connection *conn,
571                                    NTTIME now,
572                                    struct smbXsrv_session_auth0 **_a);
573 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
574                                      struct smbXsrv_connection *conn,
575                                      NTTIME now,
576                                      uint8_t in_flags,
577                                      uint8_t in_security_mode,
578                                      struct smbXsrv_session_auth0 **_a);
579 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
580                                         struct tevent_context *ev,
581                                         struct smbXsrv_session *session,
582                                         struct smbd_smb2_request *current_req);
583 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
584 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
585 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
586 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
587 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
588                                 uint16_t vuid, NTTIME now,
589                                 struct smbXsrv_session **session);
590 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
591 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
592                                      uint64_t session_id, NTTIME now,
593                                      struct smbXsrv_session **session);
594 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
595                                        uint64_t session_id, NTTIME now,
596                                        struct smbXsrv_session **session);
597 struct smbXsrv_session_global0;
598 NTSTATUS smbXsrv_session_global_traverse(
599                         int (*fn)(struct smbXsrv_session_global0 *, void *),
600                         void *private_data);
601 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
602                                         struct tevent_context *ev,
603                                         struct smbXsrv_connection *conn,
604                                         struct auth_session_info *session_info,
605                                         uint64_t previous_session_id,
606                                         uint64_t current_session_id);
607 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
608
609 NTSTATUS smbXsrv_tcon_global_init(void);
610 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
611 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
612 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
613 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
614                              NTTIME now,
615                              struct smbXsrv_tcon **_tcon);
616 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
617                              uint16_t tree_id, NTTIME now,
618                              struct smbXsrv_tcon **tcon);
619 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
620 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
621 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
622                              NTTIME now,
623                              struct smbXsrv_tcon **_tcon);
624 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
625                              uint32_t tree_id, NTTIME now,
626                              struct smbXsrv_tcon **tcon);
627 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
628 struct smbXsrv_tcon_global0;
629 NTSTATUS smbXsrv_tcon_global_traverse(
630                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
631                         void *private_data);
632
633 NTSTATUS smbXsrv_open_global_init(void);
634 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
635                              struct auth_session_info *session_info,
636                              NTTIME now,
637                              struct smbXsrv_open **_open);
638 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
639 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
640 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
641 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
642 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
643                              uint16_t fnum, NTTIME now,
644                              struct smbXsrv_open **_open);
645 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
646 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
647                              uint64_t persistent_id,
648                              uint64_t volatile_id,
649                              NTTIME now,
650                              struct smbXsrv_open **_open);
651 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
652                                           const struct GUID *create_guid,
653                                           NTTIME now,
654                                           struct smbXsrv_open **_open);
655 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
656                                struct auth_session_info *session_info,
657                                uint64_t persistent_id,
658                                const struct GUID *create_guid,
659                                NTTIME now,
660                                struct smbXsrv_open **_open);
661 struct smbXsrv_open_global0;
662 NTSTATUS smbXsrv_open_global_traverse(
663         int (*fn)(struct smbXsrv_open_global0 *, void *),
664         void *private_data);
665
666 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
667 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
668 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
669 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
670 bool smbXsrv_is_signed(uint8_t signing_flags);
671 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
672
673 struct smbd_smb2_send_queue {
674         struct smbd_smb2_send_queue *prev, *next;
675
676         DATA_BLOB *sendfile_header;
677         NTSTATUS *sendfile_status;
678         struct iovec *vector;
679         int count;
680
681         TALLOC_CTX *mem_ctx;
682 };
683
684 struct smbd_smb2_request {
685         struct smbd_smb2_request *prev, *next;
686
687         struct smbd_server_connection *sconn;
688         struct smbXsrv_connection *xconn;
689
690         struct smbd_smb2_send_queue queue_entry;
691
692         /* the session the request operates on, maybe NULL */
693         struct smbXsrv_session *session;
694         uint64_t last_session_id;
695
696         /* the tcon the request operates on, maybe NULL */
697         struct smbXsrv_tcon *tcon;
698         uint32_t last_tid;
699
700         int current_idx;
701         bool do_signing;
702         /* Was the request encrypted? */
703         bool was_encrypted;
704         /* Should we encrypt? */
705         bool do_encryption;
706         struct tevent_timer *async_te;
707         bool compound_related;
708
709         /*
710          * the encryption key for the whole
711          * compound chain
712          */
713         DATA_BLOB first_key;
714         /*
715          * the signing key for the last
716          * request/response of a compound chain
717          */
718         DATA_BLOB last_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
736         /*
737          * The sub request for async backend calls.
738          * This is used for SMB2 Cancel.
739          */
740         struct tevent_req *subreq;
741
742 #define SMBD_SMB2_TF_IOV_OFS 0
743 #define SMBD_SMB2_HDR_IOV_OFS 1
744 #define SMBD_SMB2_BODY_IOV_OFS 2
745 #define SMBD_SMB2_DYN_IOV_OFS 3
746
747 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
748
749 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
750         (&req->dir.vector[(idx)+(ofs)])
751
752 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
753         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
754 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
755         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
756 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
757         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
758 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
759         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
760
761 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
762 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
763 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
764 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
765 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
766 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
767 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
768 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
769 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
770 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
771
772 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
773 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
774 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
775 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
776 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
777 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
778 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
779 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
780 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
781 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
782
783 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
784
785         struct {
786                 /*
787                  * vector[0] TRANSPORT HEADER (empty)
788                  * .
789                  * vector[1] SMB2_TRANSFORM (optional)
790                  * vector[2] SMB2
791                  * vector[3] fixed body
792                  * vector[4] dynamic body
793                  * .
794                  * .
795                  * .
796                  * vector[5] SMB2_TRANSFORM (optional)
797                  * vector[6] SMB2
798                  * vector[7] fixed body
799                  * vector[8] dynamic body
800                  * .
801                  * .
802                  * .
803                  */
804                 struct iovec *vector;
805                 int vector_count;
806                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
807         } in;
808         struct {
809                 /* the NBT header is not allocated */
810                 uint8_t nbt_hdr[4];
811                 /*
812                  * vector[0] TRANSPORT HEADER
813                  * .
814                  * vector[1] SMB2_TRANSFORM (optional)
815                  * vector[2] SMB2
816                  * vector[3] fixed body
817                  * vector[4] dynamic body
818                  * .
819                  * .
820                  * .
821                  * vector[5] SMB2_TRANSFORM (empty)
822                  * vector[6] SMB2
823                  * vector[7] fixed body
824                  * vector[8] dynamic body
825                  * .
826                  * .
827                  * .
828                  */
829                 struct iovec *vector;
830                 int vector_count;
831                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
832 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
833                 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
834                 uint8_t _body[0x58];
835         } out;
836 };
837
838 struct smbd_server_connection;
839 struct user_struct;
840
841 struct pending_message_list;
842 struct pending_auth_data;
843
844 struct user_struct {
845         struct user_struct *next, *prev;
846         uint64_t vuid; /* Tag for this entry. */
847
848         char *session_keystr; /* used by utmp and pam session code.
849                                  TDB key string */
850         int homes_snum;
851
852         struct auth_session_info *session_info;
853
854         struct smbXsrv_session *session;
855 };
856
857 struct pthreadpool_tevent;
858
859 struct smbd_server_connection {
860         const struct tsocket_address *local_address;
861         const struct tsocket_address *remote_address;
862         const char *remote_hostname;
863         struct tevent_context *ev_ctx;
864         struct messaging_context *msg_ctx;
865         struct notify_context *notify_ctx;
866         bool using_smb2;
867         bool aapl_zero_file_id; /* Apple-specific */
868         int trans_num;
869
870         size_t num_users;
871         struct user_struct *users;
872
873         size_t num_connections;
874         struct connection_struct *connections;
875
876         size_t num_files;
877         struct files_struct *files;
878
879         int real_max_open_files;
880         struct fsp_singleton_cache fsp_fi_cache;
881
882         struct pending_message_list *deferred_open_queue;
883
884
885         /* open directory handles. */
886         struct {
887                 struct bitmap *dptr_bmap;
888                 struct dptr_struct *dirptrs;
889                 int dirhandles_open;
890         } searches;
891
892         uint64_t num_requests;
893
894         /* Current number of oplocks we have outstanding. */
895         struct {
896                 int32_t exclusive_open;
897                 int32_t level_II_open;
898                 struct kernel_oplocks *kernel_ops;
899         } oplocks;
900
901         struct {
902                 struct notify_mid_map *notify_mid_maps;
903
904                 struct {
905                         /* dlink list we store pending lock records on. */
906                         struct blocking_lock_record *blocking_lock_queue;
907                         /* dlink list we move cancelled lock records onto. */
908                         struct blocking_lock_record *blocking_lock_cancelled_queue;
909
910                         /* The event that makes us process our blocking lock queue */
911                         struct tevent_timer *brl_timeout;
912
913                         bool blocking_lock_unlock_state;
914                         bool blocking_lock_cancel_state;
915                 } locks;
916         } smb1;
917         struct {
918                 struct {
919                         /* The event that makes us process our blocking lock queue */
920                         struct tevent_timer *brl_timeout;
921                         bool blocking_lock_unlock_state;
922                 } locks;
923         } smb2;
924
925         struct pthreadpool_tevent *pool;
926
927         struct smbXsrv_client *client;
928 };
929
930 extern struct smbXsrv_client *global_smbXsrv_client;
931
932 void smbd_init_globals(void);