s3/smbd: add file_id return arg to smbd_dirptr_lanman2_entry
[amitay/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 #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                                struct file_id *file_id);
211
212 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
213                                     const struct smb_filename *smb_fname,
214                                     bool use_privs,
215                                     uint32_t access_mask,
216                                     uint32_t *access_mask_out);
217
218 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
219
220 void smbd_server_connection_terminate_ex(struct smbXsrv_connection *xconn,
221                                          const char *reason,
222                                          const char *location);
223 #define smbd_server_connection_terminate(xconn, reason) \
224         smbd_server_connection_terminate_ex(xconn, reason, __location__)
225
226 const char *smb2_opcode_name(uint16_t opcode);
227 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
228
229 NTSTATUS smbd_add_connection(struct smbXsrv_client *client, int sock_fd,
230                              struct smbXsrv_connection **_xconn);
231
232 void reply_smb2002(struct smb_request *req, uint16_t choice);
233 void reply_smb20ff(struct smb_request *req, uint16_t choice);
234 void smbd_smb2_process_negprot(struct smbXsrv_connection *xconn,
235                                uint64_t expected_seq_low,
236                                const uint8_t *inpdu, size_t size);
237
238 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
239
240 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
241                                     NTSTATUS status,
242                                     DATA_BLOB *info,
243                                     const char *location);
244 #define smbd_smb2_request_error(req, status) \
245         smbd_smb2_request_error_ex(req, status, NULL, __location__)
246 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
247                                    NTSTATUS status,
248                                    DATA_BLOB body, DATA_BLOB *dyn,
249                                    const char *location);
250 #define smbd_smb2_request_done(req, body, dyn) \
251         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
252
253 NTSTATUS smbd_smb2_send_oplock_break(struct smbXsrv_connection *xconn,
254                                      struct smbXsrv_session *session,
255                                      struct smbXsrv_tcon *tcon,
256                                      struct smbXsrv_open *op,
257                                      uint8_t oplock_level);
258 NTSTATUS smbd_smb2_send_lease_break(struct smbXsrv_connection *xconn,
259                                     uint16_t new_epoch,
260                                     uint32_t lease_flags,
261                                     struct smb2_lease_key *lease_key,
262                                     uint32_t current_lease_state,
263                                     uint32_t new_lease_state);
264
265 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
266                                          struct tevent_req *subreq,
267                                          uint32_t defer_time);
268
269 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
270 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
271 void remove_smb2_chained_fsp(files_struct *fsp);
272
273 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
274                                                uint32_t data_length);
275
276 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
277                                         size_t expected_body_size);
278
279 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
280                                                      const int dialect_count,
281                                                      uint16_t *dialect);
282 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
283 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
284 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
285 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
286 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
287 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
288 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
289 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
290 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
291 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
292 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
293 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
294 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
295                                     int err);
296 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
297 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
298 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
299 NTSTATUS smbd_smb2_request_process_query_directory(struct smbd_smb2_request *req);
300 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
301 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
302 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
303 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
304 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
305 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
306                                 struct tevent_immediate *im,
307                                 void *private_data);
308
309 struct deferred_open_record;
310
311 /* SMB1 -> SMB2 glue. */
312 void send_break_message_smb2(files_struct *fsp,
313                              uint32_t break_from,
314                              uint32_t break_to);
315 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
316 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
317                                 struct smb_request *req,
318                                 files_struct *fsp,
319                                 int lock_timeout,
320                                 int lock_num,
321                                 uint64_t smblctx,
322                                 enum brl_type lock_type,
323                                 enum brl_flavour lock_flav,
324                                 uint64_t offset,
325                                 uint64_t count,
326                                 uint64_t blocking_smblctx);
327 void process_blocking_lock_queue_smb2(
328         struct smbd_server_connection *sconn, struct timeval tv_curr);
329 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
330                         struct byte_range_lock *br_lck,
331                         enum file_close_type close_type);
332 /* From smbd/smb2_create.c */
333 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
334 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
335                         struct timeval *p_request_time,
336                         struct deferred_open_record **open_rec);
337 bool open_was_deferred_smb2(
338         struct smbXsrv_connection *xconn, uint64_t mid);
339 void remove_deferred_open_message_smb2(
340         struct smbXsrv_connection *xconn, uint64_t mid);
341 bool schedule_deferred_open_message_smb2(
342         struct smbXsrv_connection *xconn, uint64_t mid);
343 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
344                                 struct timeval request_time,
345                                 struct timeval timeout,
346                                 struct file_id id,
347                                 struct deferred_open_record *open_rec);
348
349 struct smbXsrv_client;
350
351 struct smbXsrv_preauth {
352         uint8_t sha512_value[64];
353 };
354
355 struct smbXsrv_connection {
356         struct smbXsrv_connection *prev, *next;
357
358         struct smbXsrv_client *client;
359
360
361         const struct tsocket_address *local_address;
362         const struct tsocket_address *remote_address;
363         const char *remote_hostname;
364
365         struct tevent_context *ev_ctx;
366         struct messaging_context *msg_ctx;
367
368         enum protocol_types protocol;
369
370         struct {
371                 NTSTATUS status;
372                 int sock;
373                 struct tevent_fd *fde;
374
375                 struct {
376                         bool got_session;
377                 } nbt;
378         } transport;
379
380         struct {
381                 struct {
382                         /*
383                          * fd for the fcntl lock and process shared
384                          * robust mutex to coordinate access to the
385                          * client socket. When the system supports
386                          * process shared robust mutexes, those are
387                          * used. If not, then the fcntl lock will be
388                          * used.
389                          */
390                         int socket_lock_fd;
391 #ifdef HAVE_ROBUST_MUTEXES
392                         pthread_mutex_t *socket_mutex;
393 #endif
394
395                         /*
396                          * fd for the trusted pipe from
397                          * echo handler child
398                          */
399                         int trusted_fd;
400
401                         /*
402                          * fde for the trusted_fd
403                          */
404                         struct tevent_fd *trusted_fde;
405
406                         /*
407                          * Reference count for the fcntl lock to
408                          * allow recursive locks.
409                          */
410                         int ref_count;
411                 } echo_handler;
412
413                 struct {
414                         bool encrypted_passwords;
415                         bool spnego;
416                         struct auth4_context *auth_context;
417                         bool done;
418                         /*
419                          * Size of the data we can receive. Set by us.
420                          * Can be modified by the max xmit parameter.
421                          */
422                         int max_recv;
423                 } negprot;
424
425                 struct {
426                         bool done_sesssetup;
427                         /*
428                          * Size of data we can send to client. Set
429                          *  by the client for all protocols above CORE.
430                          *  Set by us for CORE protocol.
431                          */
432                         int max_send;
433                 } sessions;
434                 struct smb_signing_state *signing_state;
435
436                 struct {
437                         uint16_t client_major;
438                         uint16_t client_minor;
439                         uint32_t client_cap_low;
440                         uint32_t client_cap_high;
441                 } unix_info;
442
443                 struct msg_state *msg_state;
444         } smb1;
445         struct {
446                 struct smbd_smb2_request_read_state {
447                         struct smbd_smb2_request *req;
448                         struct {
449                                 uint8_t nbt[NBT_HDR_SIZE];
450                                 bool done;
451                         } hdr;
452                         struct iovec vector;
453                         bool doing_receivefile;
454                         size_t min_recv_size;
455                         size_t pktfull;
456                         size_t pktlen;
457                         uint8_t *pktbuf;
458                 } request_read_state;
459                 struct smbd_smb2_send_queue *send_queue;
460                 size_t send_queue_len;
461
462                 struct {
463                         /*
464                          * seq_low is the lowest sequence number
465                          * we will accept.
466                          */
467                         uint64_t seq_low;
468                         /*
469                          * seq_range is the range of credits we have
470                          * granted from the sequence windows starting
471                          * at seq_low.
472                          *
473                          * This gets incremented when new credits are
474                          * granted and gets decremented when the
475                          * lowest sequence number is consumed
476                          * (when seq_low gets incremented).
477                          */
478                         uint16_t seq_range;
479                         /*
480                          * The number of credits we have currently granted
481                          * to the client.
482                          *
483                          * This gets incremented when new credits are
484                          * granted and gets decremented when any credit
485                          * is comsumed.
486                          *
487                          * Note: the decrementing is different compared
488                          *       to seq_range.
489                          */
490                         uint16_t granted;
491                         /*
492                          * The maximum number of credits we will ever
493                          * grant to the client.
494                          *
495                          * Typically we will only grant 1/16th of
496                          * max_credits.
497                          *
498                          * This is the "server max credits" parameter.
499                          */
500                         uint16_t max;
501                         /*
502                          * a bitmap of size max_credits
503                          */
504                         struct bitmap *bitmap;
505                         bool multicredit;
506                 } credits;
507
508                 bool allow_2ff;
509                 struct {
510                         uint32_t capabilities;
511                         struct GUID guid;
512                         bool guid_verified;
513                         uint16_t security_mode;
514                         uint16_t num_dialects;
515                         uint16_t *dialects;
516                 } client;
517                 struct {
518                         uint32_t capabilities;
519                         struct GUID guid;
520                         uint16_t security_mode;
521                         uint16_t dialect;
522                         uint32_t max_trans;
523                         uint32_t max_read;
524                         uint32_t max_write;
525                         uint16_t cipher;
526                 } server;
527
528                 struct smbXsrv_preauth preauth;
529
530                 struct smbd_smb2_request *requests;
531         } smb2;
532 };
533
534 const char *smbXsrv_connection_dbg(const struct smbXsrv_connection *xconn);
535
536 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
537 uint32_t smbXsrv_version_global_current(void);
538
539 struct smbXsrv_client_table;
540 NTSTATUS smbXsrv_client_global_init(void);
541 NTSTATUS smbXsrv_client_create(TALLOC_CTX *mem_ctx,
542                                struct tevent_context *ev_ctx,
543                                struct messaging_context *msg_ctx,
544                                NTTIME now,
545                                struct smbXsrv_client **_client);
546 NTSTATUS smbXsrv_client_update(struct smbXsrv_client *client);
547 NTSTATUS smbXsrv_client_remove(struct smbXsrv_client *client);
548 NTSTATUS smb2srv_client_lookup_global(struct smbXsrv_client *client,
549                                       struct GUID client_guid,
550                                       TALLOC_CTX *mem_ctx,
551                                       struct smbXsrv_client_global0 **_pass);
552 NTSTATUS smb2srv_client_connection_pass(struct smbd_smb2_request *smb2req,
553                                         struct smbXsrv_client_global0 *global);
554
555 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
556                                         enum protocol_types protocol);
557
558 NTSTATUS smbXsrv_session_global_init(struct messaging_context *msg_ctx);
559 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
560                                 NTTIME now,
561                                 struct smbXsrv_session **_session);
562 NTSTATUS smbXsrv_session_add_channel(struct smbXsrv_session *session,
563                                      struct smbXsrv_connection *conn,
564                                      struct smbXsrv_channel_global0 **_c);
565 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
566 struct smbXsrv_channel_global0;
567 NTSTATUS smbXsrv_session_find_channel(const struct smbXsrv_session *session,
568                                       const struct smbXsrv_connection *conn,
569                                       struct smbXsrv_channel_global0 **_c);
570 NTSTATUS smbXsrv_session_find_auth(const struct smbXsrv_session *session,
571                                    const struct smbXsrv_connection *conn,
572                                    NTTIME now,
573                                    struct smbXsrv_session_auth0 **_a);
574 NTSTATUS smbXsrv_session_create_auth(struct smbXsrv_session *session,
575                                      struct smbXsrv_connection *conn,
576                                      NTTIME now,
577                                      uint8_t in_flags,
578                                      uint8_t in_security_mode,
579                                      struct smbXsrv_session_auth0 **_a);
580 struct tevent_req *smb2srv_session_shutdown_send(TALLOC_CTX *mem_ctx,
581                                         struct tevent_context *ev,
582                                         struct smbXsrv_session *session,
583                                         struct smbd_smb2_request *current_req);
584 NTSTATUS smb2srv_session_shutdown_recv(struct tevent_req *req);
585 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
586 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
587 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
588 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
589                                 uint16_t vuid, NTTIME now,
590                                 struct smbXsrv_session **session);
591 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
592 NTSTATUS smb2srv_session_lookup_conn(struct smbXsrv_connection *conn,
593                                      uint64_t session_id, NTTIME now,
594                                      struct smbXsrv_session **session);
595 NTSTATUS smb2srv_session_lookup_client(struct smbXsrv_client *client,
596                                        uint64_t session_id, NTTIME now,
597                                        struct smbXsrv_session **session);
598 struct smbXsrv_session_global0;
599 NTSTATUS smbXsrv_session_global_traverse(
600                         int (*fn)(struct smbXsrv_session_global0 *, void *),
601                         void *private_data);
602 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
603                                         struct tevent_context *ev,
604                                         struct smbXsrv_connection *conn,
605                                         struct auth_session_info *session_info,
606                                         uint64_t previous_session_id,
607                                         uint64_t current_session_id);
608 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
609
610 NTSTATUS smbXsrv_tcon_global_init(void);
611 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
612 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
613 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
614 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
615                              NTTIME now,
616                              struct smbXsrv_tcon **_tcon);
617 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
618                              uint16_t tree_id, NTTIME now,
619                              struct smbXsrv_tcon **tcon);
620 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
621 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
622 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
623                              NTTIME now,
624                              struct smbXsrv_tcon **_tcon);
625 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
626                              uint32_t tree_id, NTTIME now,
627                              struct smbXsrv_tcon **tcon);
628 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
629 struct smbXsrv_tcon_global0;
630 NTSTATUS smbXsrv_tcon_global_traverse(
631                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
632                         void *private_data);
633
634 NTSTATUS smbXsrv_open_global_init(void);
635 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
636                              struct auth_session_info *session_info,
637                              NTTIME now,
638                              struct smbXsrv_open **_open);
639 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
640 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
641 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
642 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
643 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
644                              uint16_t fnum, NTTIME now,
645                              struct smbXsrv_open **_open);
646 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
647 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
648                              uint64_t persistent_id,
649                              uint64_t volatile_id,
650                              NTTIME now,
651                              struct smbXsrv_open **_open);
652 NTSTATUS smb2srv_open_lookup_replay_cache(struct smbXsrv_connection *conn,
653                                           const struct GUID *create_guid,
654                                           NTTIME now,
655                                           struct smbXsrv_open **_open);
656 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
657                                struct auth_session_info *session_info,
658                                uint64_t persistent_id,
659                                const struct GUID *create_guid,
660                                NTTIME now,
661                                struct smbXsrv_open **_open);
662 struct smbXsrv_open_global0;
663 NTSTATUS smbXsrv_open_global_traverse(
664         int (*fn)(struct smbXsrv_open_global0 *, void *),
665         void *private_data);
666
667 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
668 bool smbXsrv_is_encrypted(uint8_t encryption_flags);
669 bool smbXsrv_is_partially_encrypted(uint8_t encryption_flags);
670 bool smbXsrv_set_crypto_flag(uint8_t *flags, uint8_t flag);
671 bool smbXsrv_is_signed(uint8_t signing_flags);
672 bool smbXsrv_is_partially_signed(uint8_t signing_flags);
673
674 struct smbd_smb2_send_queue {
675         struct smbd_smb2_send_queue *prev, *next;
676
677         DATA_BLOB *sendfile_header;
678         NTSTATUS *sendfile_status;
679         struct iovec *vector;
680         int count;
681
682         TALLOC_CTX *mem_ctx;
683 };
684
685 struct smbd_smb2_request {
686         struct smbd_smb2_request *prev, *next;
687
688         struct smbd_server_connection *sconn;
689         struct smbXsrv_connection *xconn;
690
691         struct smbd_smb2_send_queue queue_entry;
692
693         /* the session the request operates on, maybe NULL */
694         struct smbXsrv_session *session;
695         uint64_t last_session_id;
696
697         /* the tcon the request operates on, maybe NULL */
698         struct smbXsrv_tcon *tcon;
699         uint32_t last_tid;
700
701         int current_idx;
702         bool do_signing;
703         /* Was the request encrypted? */
704         bool was_encrypted;
705         /* Should we encrypt? */
706         bool do_encryption;
707         struct tevent_timer *async_te;
708         bool compound_related;
709
710         /*
711          * the encryption key for the whole
712          * compound chain
713          */
714         DATA_BLOB first_key;
715         /*
716          * the signing key for the last
717          * request/response of a compound chain
718          */
719         DATA_BLOB last_key;
720         struct smbXsrv_preauth *preauth;
721
722         struct timeval request_time;
723
724         SMBPROFILE_IOBYTES_ASYNC_STATE(profile);
725
726         /* fake smb1 request. */
727         struct smb_request *smb1req;
728         struct files_struct *compat_chain_fsp;
729
730         /*
731          * Keep track of whether the outstanding request counters
732          * had been updated in dispatch, so that they need to be
733          * adapted again in reply.
734          */
735         bool request_counters_updated;
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 struct user_struct;
841
842 struct pending_message_list;
843 struct pending_auth_data;
844
845 struct user_struct {
846         struct user_struct *next, *prev;
847         uint64_t vuid; /* Tag for this entry. */
848
849         char *session_keystr; /* used by utmp and pam session code.
850                                  TDB key string */
851         int homes_snum;
852
853         struct auth_session_info *session_info;
854
855         struct smbXsrv_session *session;
856 };
857
858 struct pthreadpool_tevent;
859
860 struct smbd_server_connection {
861         const struct tsocket_address *local_address;
862         const struct tsocket_address *remote_address;
863         const char *remote_hostname;
864         struct tevent_context *ev_ctx;
865         struct messaging_context *msg_ctx;
866         struct notify_context *notify_ctx;
867         bool using_smb2;
868         bool aapl_zero_file_id; /* Apple-specific */
869         int trans_num;
870
871         size_t num_users;
872         struct user_struct *users;
873
874         size_t num_connections;
875         struct connection_struct *connections;
876
877         size_t num_files;
878         struct files_struct *files;
879
880         int real_max_open_files;
881         struct fsp_singleton_cache fsp_fi_cache;
882
883         struct pending_message_list *deferred_open_queue;
884
885
886         /* open directory handles. */
887         struct {
888                 struct bitmap *dptr_bmap;
889                 struct dptr_struct *dirptrs;
890                 int dirhandles_open;
891         } searches;
892
893         uint64_t num_requests;
894
895         /* Current number of oplocks we have outstanding. */
896         struct {
897                 int32_t exclusive_open;
898                 int32_t level_II_open;
899                 struct kernel_oplocks *kernel_ops;
900         } oplocks;
901
902         struct {
903                 struct notify_mid_map *notify_mid_maps;
904
905                 struct {
906                         /* dlink list we store pending lock records on. */
907                         struct blocking_lock_record *blocking_lock_queue;
908                         /* dlink list we move cancelled lock records onto. */
909                         struct blocking_lock_record *blocking_lock_cancelled_queue;
910
911                         /* The event that makes us process our blocking lock queue */
912                         struct tevent_timer *brl_timeout;
913
914                         bool blocking_lock_unlock_state;
915                         bool blocking_lock_cancel_state;
916                 } locks;
917         } smb1;
918         struct {
919                 struct {
920                         /* The event that makes us process our blocking lock queue */
921                         struct tevent_timer *brl_timeout;
922                         bool blocking_lock_unlock_state;
923                 } locks;
924         } smb2;
925
926         struct pthreadpool_tevent *pool;
927
928         struct smbXsrv_client *client;
929 };
930
931 extern struct smbXsrv_client *global_smbXsrv_client;
932
933 void smbd_init_globals(void);