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
  24 extern int aio_pending_size;
  25 extern int outstanding_aio_calls;
  26
  27 #ifdef USE_DMAPI
  28 struct smbd_dmapi_context;
  29 extern struct smbd_dmapi_context *dmapi_ctx;
  30 #endif
  31
  32 extern bool dfree_broken;
  33
  34 /* how many write cache buffers have been allocated */
  35 extern unsigned int allocated_write_caches;
  36
  37 /* A singleton cache to speed up searching by dev/inode. */
  38 struct fsp_singleton_cache {
  39         files_struct *fsp;
  40         struct file_id id;
  41 };
  42
  43 extern const struct mangle_fns *mangle_fns;
  44
  45 extern unsigned char *chartest;
  46 struct tdb_context;
  47 extern struct tdb_context *tdb_mangled_cache;
  48
  49 /*
  50   this determines how many characters are used from the original filename
  51   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
  52   The largest possible value is 6.
  53 */
  54 extern unsigned mangle_prefix;
  55
  56 struct msg_state;
  57
  58 extern bool logged_ioctl_message;
  59
  60 extern int trans_num;
  61
  62 extern time_t last_smb_conf_reload_time;
  63 extern time_t last_printer_reload_time;
  64 extern pid_t background_lpq_updater_pid;
  65
  66 /****************************************************************************
  67  structure to hold a linked list of queued messages.
  68  for processing.
  69 ****************************************************************************/
  70 extern uint32_t common_flags2;
  71
  72 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
  73 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
  74
  75 struct sec_ctx {
  76         struct security_unix_token ut;
  77         struct security_token *token;
  78 };
  79 /* A stack of security contexts.  We include the current context as being
  80    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
  81 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
  82 extern int sec_ctx_stack_ndx;
  83 extern bool become_uid_done;
  84 extern bool become_gid_done;
  85
  86 extern connection_struct *last_conn;
  87 extern uint16_t last_flags;
  88
  89 extern uint32_t global_client_caps;
  90
  91 extern uint16_t fnf_handle;
  92
  93 struct conn_ctx {
  94         connection_struct *conn;
  95         uint64_t vuid;
  96 };
  97 /* A stack of current_user connection contexts. */
  98 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
  99 extern int conn_ctx_stack_ndx;
 100
 101 struct vfs_init_function_entry;
 102 extern struct vfs_init_function_entry *backends;
 103 extern char *sparse_buf;
 104 extern char *LastDir;
 105
 106 struct smbd_parent_context;
 107 extern struct smbd_parent_context *am_parent;
 108 extern struct memcache *smbd_memcache_ctx;
 109 extern bool exit_firsttime;
 110
 111 struct tstream_context;
 112 struct smbd_smb2_request;
 113
 114 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
 115
 116 void smbd_lock_socket(struct smbd_server_connection *sconn);
 117 void smbd_unlock_socket(struct smbd_server_connection *sconn);
 118
 119 NTSTATUS smbd_do_locking(struct smb_request *req,
 120                          files_struct *fsp,
 121                          uint8_t type,
 122                          int32_t timeout,
 123                          uint16_t num_ulocks,
 124                          struct smbd_lock_element *ulocks,
 125                          uint16_t num_locks,
 126                          struct smbd_lock_element *locks,
 127                          bool *async);
 128
 129 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
 130                                TALLOC_CTX *mem_ctx,
 131                                uint16_t info_level,
 132                                files_struct *fsp,
 133                                struct smb_filename *smb_fname,
 134                                bool delete_pending,
 135                                struct timespec write_time_ts,
 136                                struct ea_list *ea_list,
 137                                int lock_data_count,
 138                                char *lock_data,
 139                                uint16_t flags2,
 140                                unsigned int max_data_bytes,
 141                                size_t *fixed_portion,
 142                                char **ppdata,
 143                                unsigned int *pdata_size);
 144
 145 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
 146                                 struct smb_request *req,
 147                                 TALLOC_CTX *mem_ctx,
 148                                 uint16_t info_level,
 149                                 files_struct *fsp,
 150                                 struct smb_filename *smb_fname,
 151                                 char **ppdata, int total_data,
 152                                 int *ret_data_size);
 153
 154 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
 155                          TALLOC_CTX *mem_ctx,
 156                          uint16_t info_level,
 157                          uint16_t flags2,
 158                          unsigned int max_data_bytes,
 159                          size_t *fixed_portion,
 160                          struct smb_filename *smb_fname,
 161                          char **ppdata,
 162                          int *ret_data_len);
 163
 164 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
 165                            struct dptr_struct *dirptr,
 166                            const char *mask,
 167                            uint32_t dirtype,
 168                            bool dont_descend,
 169                            bool ask_sharemode,
 170                            bool (*match_fn)(TALLOC_CTX *ctx,
 171                                             void *private_data,
 172                                             const char *dname,
 173                                             const char *mask,
 174                                             char **_fname),
 175                            bool (*mode_fn)(TALLOC_CTX *ctx,
 176                                            void *private_data,
 177                                            struct smb_filename *smb_fname,
 178                                            uint32_t *_mode),
 179                            void *private_data,
 180                            char **_fname,
 181                            struct smb_filename **_smb_fname,
 182                            uint32_t *_mode,
 183                            long *_prev_offset);
 184
 185 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
 186                                connection_struct *conn,
 187                                struct dptr_struct *dirptr,
 188                                uint16 flags2,
 189                                const char *path_mask,
 190                                uint32 dirtype,
 191                                int info_level,
 192                                int requires_resume_key,
 193                                bool dont_descend,
 194                                bool ask_sharemode,
 195                                uint8_t align,
 196                                bool do_pad,
 197                                char **ppdata,
 198                                char *base_data,
 199                                char *end_data,
 200                                int space_remaining,
 201                                bool *out_of_space,
 202                                bool *got_exact_match,
 203                                int *_last_entry_off,
 204                                struct ea_list *name_list);
 205
 206 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
 207                                     const struct smb_filename *smb_fname,
 208                                     bool use_privs,
 209                                     uint32_t access_mask,
 210                                     uint32_t *access_mask_out);
 211
 212 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
 213
 214 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 215                                          const char *reason,
 216                                          const char *location);
 217 #define smbd_server_connection_terminate(sconn, reason) \
 218         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 219
 220 const char *smb2_opcode_name(uint16_t opcode);
 221 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
 222
 223 void reply_smb2002(struct smb_request *req, uint16_t choice);
 224 void reply_smb20ff(struct smb_request *req, uint16_t choice);
 225 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
 226                              uint8_t *inbuf, size_t size);
 227
 228 DATA_BLOB smbd_smb2_generate_outbody(struct smbd_smb2_request *req, size_t size);
 229
 230 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
 231                                     NTSTATUS status,
 232                                     DATA_BLOB *info,
 233                                     const char *location);
 234 #define smbd_smb2_request_error(req, status) \
 235         smbd_smb2_request_error_ex(req, status, NULL, __location__)
 236 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
 237                                    NTSTATUS status,
 238                                    DATA_BLOB body, DATA_BLOB *dyn,
 239                                    const char *location);
 240 #define smbd_smb2_request_done(req, body, dyn) \
 241         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
 242
 243 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
 244                                      struct smbXsrv_session *session,
 245                                      struct smbXsrv_tcon *tcon,
 246                                      struct smbXsrv_open *op,
 247                                      uint8_t oplock_level);
 248
 249 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
 250                                          struct tevent_req *subreq,
 251                                          uint32_t defer_time);
 252
 253 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
 254 size_t smbd_smb2_unread_bytes(struct smbd_smb2_request *req);
 255 void remove_smb2_chained_fsp(files_struct *fsp);
 256
 257 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
 258                                                uint32_t data_length);
 259
 260 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
 261                                         size_t expected_body_size);
 262
 263 enum protocol_types smbd_smb2_protocol_dialect_match(const uint8_t *indyn,
 264                                                      const int dialect_count,
 265                                                      uint16_t *dialect);
 266 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 267 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 268 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 269 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 270 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 271 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 272 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 273 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 274 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 275 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
 276 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 277 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
 278 NTSTATUS smb2_write_complete_nosync(struct tevent_req *req, ssize_t nwritten,
 279                                     int err);
 280 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 281 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 282 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 283 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 284 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 285 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 286 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 287 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 288 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
 289 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
 290                                 struct tevent_immediate *im,
 291                                 void *private_data);
 292
 293 struct deferred_open_record;
 294
 295 /* SMB1 -> SMB2 glue. */
 296 void send_break_message_smb2(files_struct *fsp, int level);
 297 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
 298 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
 299                                 struct smb_request *req,
 300                                 files_struct *fsp,
 301                                 int lock_timeout,
 302                                 int lock_num,
 303                                 uint64_t smblctx,
 304                                 enum brl_type lock_type,
 305                                 enum brl_flavour lock_flav,
 306                                 uint64_t offset,
 307                                 uint64_t count,
 308                                 uint64_t blocking_smblctx);
 309 void process_blocking_lock_queue_smb2(
 310         struct smbd_server_connection *sconn, struct timeval tv_curr);
 311 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
 312                         struct byte_range_lock *br_lck,
 313                         enum file_close_type close_type);
 314 /* From smbd/smb2_create.c */
 315 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
 316 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
 317                         struct timeval *p_request_time,
 318                         struct deferred_open_record **open_rec);
 319 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
 320                             uint64_t mid);
 321 void remove_deferred_open_message_smb2(
 322         struct smbd_server_connection *sconn, uint64_t mid);
 323 bool schedule_deferred_open_message_smb2(
 324         struct smbd_server_connection *sconn, uint64_t mid);
 325 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
 326                                 struct timeval request_time,
 327                                 struct timeval timeout,
 328                                 struct file_id id,
 329                                 struct deferred_open_record *open_rec);
 330
 331 struct smbXsrv_connection {
 332         struct smbd_server_connection *sconn;
 333
 334         const struct tsocket_address *local_address;
 335         const struct tsocket_address *remote_address;
 336         const char *remote_hostname;
 337
 338         struct tevent_context *ev_ctx;
 339         struct messaging_context *msg_ctx;
 340
 341         enum protocol_types protocol;
 342
 343         struct {
 344                 struct {
 345                         uint32_t capabilities;
 346                         struct GUID guid;
 347                         uint16_t security_mode;
 348                         uint16_t num_dialects;
 349                         uint16_t *dialects;
 350                 } client;
 351                 struct {
 352                         uint32_t capabilities;
 353                         struct GUID guid;
 354                         uint16_t security_mode;
 355                         uint16_t dialect;
 356                         uint32_t max_trans;
 357                         uint32_t max_read;
 358                         uint32_t max_write;
 359                 } server;
 360         } smb2;
 361
 362         struct msg_state *msg_state;
 363
 364         /*
 365          * Link into libasys for asynchronous operations
 366          */
 367         struct asys_context *asys_ctx;
 368         struct tevent_fd *asys_fde;
 369
 370         uint64_t smbd_idle_profstamp;
 371
 372         /*
 373          * this session_table is used for SMB1 and SMB2,
 374          */
 375         struct smbXsrv_session_table *session_table;
 376         uint64_t last_session_id;
 377         /*
 378          * this tcon_table is only used for SMB1.
 379          */
 380         struct smbXsrv_tcon_table *tcon_table;
 381         /*
 382          * this open_table is used for SMB1 and SMB2,
 383          * because we have a global sconn->real_max_open_files
 384          * limit.
 385          */
 386         struct smbXsrv_open_table *open_table;
 387 };
 388
 389 NTSTATUS smbXsrv_version_global_init(const struct server_id *server_id);
 390 uint32_t smbXsrv_version_global_current(void);
 391
 392 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
 393                                         enum protocol_types protocol);
 394
 395 NTSTATUS smbXsrv_session_global_init(void);
 396 NTSTATUS smbXsrv_session_create(struct smbXsrv_connection *conn,
 397                                 NTTIME now,
 398                                 struct smbXsrv_session **_session);
 399 NTSTATUS smbXsrv_session_update(struct smbXsrv_session *session);
 400 NTSTATUS smbXsrv_session_logoff(struct smbXsrv_session *session);
 401 NTSTATUS smbXsrv_session_logoff_all(struct smbXsrv_connection *conn);
 402 NTSTATUS smb1srv_session_table_init(struct smbXsrv_connection *conn);
 403 NTSTATUS smb1srv_session_lookup(struct smbXsrv_connection *conn,
 404                                 uint16_t vuid, NTTIME now,
 405                                 struct smbXsrv_session **session);
 406 NTSTATUS smb2srv_session_table_init(struct smbXsrv_connection *conn);
 407 NTSTATUS smb2srv_session_lookup(struct smbXsrv_connection *conn,
 408                                 uint64_t session_id, NTTIME now,
 409                                 struct smbXsrv_session **session);
 410 struct smbXsrv_session_global0;
 411 NTSTATUS smbXsrv_session_global_traverse(
 412                         int (*fn)(struct smbXsrv_session_global0 *, void *),
 413                         void *private_data);
 414 struct tevent_req *smb2srv_session_close_previous_send(TALLOC_CTX *mem_ctx,
 415                                         struct tevent_context *ev,
 416                                         struct smbXsrv_connection *conn,
 417                                         struct auth_session_info *session_info,
 418                                         uint64_t previous_session_id,
 419                                         uint64_t current_session_id);
 420 NTSTATUS smb2srv_session_close_previous_recv(struct tevent_req *req);
 421
 422 NTSTATUS smbXsrv_tcon_global_init(void);
 423 NTSTATUS smbXsrv_tcon_update(struct smbXsrv_tcon *tcon);
 424 NTSTATUS smbXsrv_tcon_disconnect(struct smbXsrv_tcon *tcon, uint64_t vuid);
 425 NTSTATUS smb1srv_tcon_table_init(struct smbXsrv_connection *conn);
 426 NTSTATUS smb1srv_tcon_create(struct smbXsrv_connection *conn,
 427                              NTTIME now,
 428                              struct smbXsrv_tcon **_tcon);
 429 NTSTATUS smb1srv_tcon_lookup(struct smbXsrv_connection *conn,
 430                              uint16_t tree_id, NTTIME now,
 431                              struct smbXsrv_tcon **tcon);
 432 NTSTATUS smb1srv_tcon_disconnect_all(struct smbXsrv_connection *conn);
 433 NTSTATUS smb2srv_tcon_table_init(struct smbXsrv_session *session);
 434 NTSTATUS smb2srv_tcon_create(struct smbXsrv_session *session,
 435                              NTTIME now,
 436                              struct smbXsrv_tcon **_tcon);
 437 NTSTATUS smb2srv_tcon_lookup(struct smbXsrv_session *session,
 438                              uint32_t tree_id, NTTIME now,
 439                              struct smbXsrv_tcon **tcon);
 440 NTSTATUS smb2srv_tcon_disconnect_all(struct smbXsrv_session *session);
 441 struct smbXsrv_tcon_global0;
 442 NTSTATUS smbXsrv_tcon_global_traverse(
 443                         int (*fn)(struct smbXsrv_tcon_global0 *, void *),
 444                         void *private_data);
 445
 446 NTSTATUS smbXsrv_open_global_init(void);
 447 NTSTATUS smbXsrv_open_create(struct smbXsrv_connection *conn,
 448                              struct auth_session_info *session_info,
 449                              NTTIME now,
 450                              struct smbXsrv_open **_open);
 451 uint32_t smbXsrv_open_hash(struct smbXsrv_open *_open);
 452 NTSTATUS smbXsrv_open_update(struct smbXsrv_open *_open);
 453 NTSTATUS smbXsrv_open_close(struct smbXsrv_open *op, NTTIME now);
 454 NTSTATUS smb1srv_open_table_init(struct smbXsrv_connection *conn);
 455 NTSTATUS smb1srv_open_lookup(struct smbXsrv_connection *conn,
 456                              uint16_t fnum, NTTIME now,
 457                              struct smbXsrv_open **_open);
 458 NTSTATUS smb2srv_open_table_init(struct smbXsrv_connection *conn);
 459 NTSTATUS smb2srv_open_lookup(struct smbXsrv_connection *conn,
 460                              uint64_t persistent_id,
 461                              uint64_t volatile_id,
 462                              NTTIME now,
 463                              struct smbXsrv_open **_open);
 464 NTSTATUS smb2srv_open_recreate(struct smbXsrv_connection *conn,
 465                                struct auth_session_info *session_info,
 466                                uint64_t persistent_id,
 467                                const struct GUID *create_guid,
 468                                NTTIME now,
 469                                struct smbXsrv_open **_open);
 470 struct smbXsrv_open_global0;
 471 NTSTATUS smbXsrv_open_global_traverse(
 472         int (*fn)(struct smbXsrv_open_global0 *, void *),
 473         void *private_data);
 474
 475 NTSTATUS smbXsrv_open_cleanup(uint64_t persistent_id);
 476
 477 struct smbd_smb2_send_queue {
 478         struct smbd_smb2_send_queue *prev, *next;
 479
 480         DATA_BLOB *sendfile_header;
 481         struct iovec *vector;
 482         int count;
 483
 484         TALLOC_CTX *mem_ctx;
 485 };
 486
 487 struct smbd_smb2_request {
 488         struct smbd_smb2_request *prev, *next;
 489
 490         struct smbd_server_connection *sconn;
 491
 492         struct smbd_smb2_send_queue queue_entry;
 493
 494         /* the session the request operates on, maybe NULL */
 495         struct smbXsrv_session *session;
 496         uint64_t last_session_id;
 497
 498         /* the tcon the request operates on, maybe NULL */
 499         struct smbXsrv_tcon *tcon;
 500         uint32_t last_tid;
 501
 502         int current_idx;
 503         bool do_signing;
 504         bool do_encryption;
 505         struct tevent_timer *async_te;
 506         bool compound_related;
 507
 508         /*
 509          * the encryption key for the whole
 510          * compound chain
 511          */
 512         DATA_BLOB first_key;
 513         /*
 514          * the signing key for the last
 515          * request/response of a compound chain
 516          */
 517         DATA_BLOB last_key;
 518
 519         struct timeval request_time;
 520
 521         /* fake smb1 request. */
 522         struct smb_request *smb1req;
 523         struct files_struct *compat_chain_fsp;
 524
 525         /*
 526          * The sub request for async backend calls.
 527          * This is used for SMB2 Cancel.
 528          */
 529         struct tevent_req *subreq;
 530
 531 #define SMBD_SMB2_TF_IOV_OFS 0
 532 #define SMBD_SMB2_HDR_IOV_OFS 1
 533 #define SMBD_SMB2_BODY_IOV_OFS 2
 534 #define SMBD_SMB2_DYN_IOV_OFS 3
 535
 536 #define SMBD_SMB2_NUM_IOV_PER_REQ 4
 537
 538 #define SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,ofs) \
 539         (&req->dir.vector[(idx)+(ofs)])
 540
 541 #define SMBD_SMB2_IDX_TF_IOV(req,dir,idx) \
 542         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_TF_IOV_OFS)
 543 #define SMBD_SMB2_IDX_HDR_IOV(req,dir,idx) \
 544         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_HDR_IOV_OFS)
 545 #define SMBD_SMB2_IDX_BODY_IOV(req,dir,idx) \
 546         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_BODY_IOV_OFS)
 547 #define SMBD_SMB2_IDX_DYN_IOV(req,dir,idx) \
 548         SMBD_SMB2_IOV_IDX_OFS(req,dir,idx,SMBD_SMB2_DYN_IOV_OFS)
 549
 550 #define SMBD_SMB2_IN_TF_IOV(req)    SMBD_SMB2_IDX_TF_IOV(req,in,req->current_idx)
 551 #define SMBD_SMB2_IN_TF_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_TF_IOV(req)->iov_base)
 552 #define SMBD_SMB2_IN_HDR_IOV(req)    SMBD_SMB2_IDX_HDR_IOV(req,in,req->current_idx)
 553 #define SMBD_SMB2_IN_HDR_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_HDR_IOV(req)->iov_base)
 554 #define SMBD_SMB2_IN_BODY_IOV(req)   SMBD_SMB2_IDX_BODY_IOV(req,in,req->current_idx)
 555 #define SMBD_SMB2_IN_BODY_PTR(req)   (uint8_t *)(SMBD_SMB2_IN_BODY_IOV(req)->iov_base)
 556 #define SMBD_SMB2_IN_BODY_LEN(req)   (SMBD_SMB2_IN_BODY_IOV(req)->iov_len)
 557 #define SMBD_SMB2_IN_DYN_IOV(req)    SMBD_SMB2_IDX_DYN_IOV(req,in,req->current_idx)
 558 #define SMBD_SMB2_IN_DYN_PTR(req)    (uint8_t *)(SMBD_SMB2_IN_DYN_IOV(req)->iov_base)
 559 #define SMBD_SMB2_IN_DYN_LEN(req)    (SMBD_SMB2_IN_DYN_IOV(req)->iov_len)
 560
 561 #define SMBD_SMB2_OUT_TF_IOV(req)   SMBD_SMB2_IDX_TF_IOV(req,out,req->current_idx)
 562 #define SMBD_SMB2_OUT_TF_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_TF_IOV(req)->iov_base)
 563 #define SMBD_SMB2_OUT_HDR_IOV(req)   SMBD_SMB2_IDX_HDR_IOV(req,out,req->current_idx)
 564 #define SMBD_SMB2_OUT_HDR_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_HDR_IOV(req)->iov_base)
 565 #define SMBD_SMB2_OUT_BODY_IOV(req)  SMBD_SMB2_IDX_BODY_IOV(req,out,req->current_idx)
 566 #define SMBD_SMB2_OUT_BODY_PTR(req)  (uint8_t *)(SMBD_SMB2_OUT_BODY_IOV(req)->iov_base)
 567 #define SMBD_SMB2_OUT_BODY_LEN(req)  (SMBD_SMB2_OUT_BODY_IOV(req)->iov_len)
 568 #define SMBD_SMB2_OUT_DYN_IOV(req)   SMBD_SMB2_IDX_DYN_IOV(req,out,req->current_idx)
 569 #define SMBD_SMB2_OUT_DYN_PTR(req)   (uint8_t *)(SMBD_SMB2_OUT_DYN_IOV(req)->iov_base)
 570 #define SMBD_SMB2_OUT_DYN_LEN(req)   (SMBD_SMB2_OUT_DYN_IOV(req)->iov_len)
 571
 572 #define SMBD_SMB2_SHORT_RECEIVEFILE_WRITE_LEN (SMB2_HDR_BODY + 0x30)
 573
 574         struct {
 575                 /*
 576                  * vector[0] TRANSPORT HEADER (empty)
 577                  * .
 578                  * vector[1] SMB2_TRANSFORM (optional)
 579                  * vector[2] SMB2
 580                  * vector[3] fixed body
 581                  * vector[4] dynamic body
 582                  * .
 583                  * .
 584                  * .
 585                  * vector[5] SMB2_TRANSFORM (optional)
 586                  * vector[6] SMB2
 587                  * vector[7] fixed body
 588                  * vector[8] dynamic body
 589                  * .
 590                  * .
 591                  * .
 592                  */
 593                 struct iovec *vector;
 594                 int vector_count;
 595                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
 596         } in;
 597         struct {
 598                 /* the NBT header is not allocated */
 599                 uint8_t nbt_hdr[4];
 600                 /*
 601                  * vector[0] TRANSPORT HEADER
 602                  * .
 603                  * vector[1] SMB2_TRANSFORM (optional)
 604                  * vector[2] SMB2
 605                  * vector[3] fixed body
 606                  * vector[4] dynamic body
 607                  * .
 608                  * .
 609                  * .
 610                  * vector[5] SMB2_TRANSFORM (empty)
 611                  * vector[6] SMB2
 612                  * vector[7] fixed body
 613                  * vector[8] dynamic body
 614                  * .
 615                  * .
 616                  * .
 617                  */
 618                 struct iovec *vector;
 619                 int vector_count;
 620                 struct iovec _vector[1 + SMBD_SMB2_NUM_IOV_PER_REQ];
 621 #define OUTVEC_ALLOC_SIZE (SMB2_HDR_BODY + 9)
 622                 uint8_t _hdr[OUTVEC_ALLOC_SIZE];
 623                 uint8_t _body[0x58];
 624         } out;
 625 };
 626
 627 struct smbd_server_connection;
 628 struct user_struct;
 629
 630 struct pending_message_list;
 631 struct pending_auth_data;
 632
 633 struct user_struct {
 634         struct user_struct *next, *prev;
 635         uint64_t vuid; /* Tag for this entry. */
 636
 637         char *session_keystr; /* used by utmp and pam session code.
 638                                  TDB key string */
 639         int homes_snum;
 640
 641         struct auth_session_info *session_info;
 642
 643         struct smbXsrv_session *session;
 644 };
 645
 646 struct smbd_server_connection {
 647         NTSTATUS status;
 648         int sock;
 649         const struct tsocket_address *local_address;
 650         const struct tsocket_address *remote_address;
 651         const char *remote_hostname;
 652         struct tevent_context *ev_ctx;
 653         struct messaging_context *msg_ctx;
 654         struct sys_notify_context *sys_notify_ctx;
 655         struct notify_context *notify_ctx;
 656         struct {
 657                 bool got_session;
 658         } nbt;
 659         bool using_smb2;
 660         int trans_num;
 661
 662         size_t num_users;
 663         struct user_struct *users;
 664
 665         size_t num_connections;
 666         struct connection_struct *connections;
 667
 668         size_t num_files;
 669         struct files_struct *files;
 670
 671         int real_max_open_files;
 672         struct fsp_singleton_cache fsp_fi_cache;
 673
 674         struct pending_message_list *deferred_open_queue;
 675
 676
 677         /* open directory handles. */
 678         struct {
 679                 struct bitmap *dptr_bmap;
 680                 struct dptr_struct *dirptrs;
 681                 int dirhandles_open;
 682         } searches;
 683
 684         uint64_t num_requests;
 685
 686         /* Current number of oplocks we have outstanding. */
 687         struct {
 688                 int32_t exclusive_open;
 689                 int32_t level_II_open;
 690                 struct kernel_oplocks *kernel_ops;
 691         } oplocks;
 692
 693         struct {
 694                 struct tevent_fd *fde;
 695
 696                 struct {
 697                         /*
 698                          * fd for the fcntl lock mutexing access to our sock
 699                          */
 700                         int socket_lock_fd;
 701
 702                         /*
 703                          * fd for the trusted pipe from
 704                          * echo handler child
 705                          */
 706                         int trusted_fd;
 707
 708                         /*
 709                          * fde for the trusted_fd
 710                          */
 711                         struct tevent_fd *trusted_fde;
 712
 713                         /*
 714                          * Reference count for the fcntl lock to
 715                          * allow recursive locks.
 716                          */
 717                         int ref_count;
 718                 } echo_handler;
 719
 720                 struct {
 721                         bool encrypted_passwords;
 722                         bool spnego;
 723                         struct auth4_context *auth_context;
 724                         bool done;
 725                         /*
 726                          * Size of the data we can receive. Set by us.
 727                          * Can be modified by the max xmit parameter.
 728                          */
 729                         int max_recv;
 730                 } negprot;
 731
 732                 struct {
 733                         uint16_t client_major;
 734                         uint16_t client_minor;
 735                         uint32_t client_cap_low;
 736                         uint32_t client_cap_high;
 737                 } unix_info;
 738
 739                 struct {
 740                         bool done_sesssetup;
 741                         /*
 742                          * Size of data we can send to client. Set
 743                          *  by the client for all protocols above CORE.
 744                          *  Set by us for CORE protocol.
 745                          */
 746                         int max_send;
 747                 } sessions;
 748                 struct smb_signing_state *signing_state;
 749
 750                 struct notify_mid_map *notify_mid_maps;
 751
 752                 struct {
 753                         /* dlink list we store pending lock records on. */
 754                         struct blocking_lock_record *blocking_lock_queue;
 755                         /* dlink list we move cancelled lock records onto. */
 756                         struct blocking_lock_record *blocking_lock_cancelled_queue;
 757
 758                         /* The event that makes us process our blocking lock queue */
 759                         struct tevent_timer *brl_timeout;
 760
 761                         bool blocking_lock_unlock_state;
 762                         bool blocking_lock_cancel_state;
 763                 } locks;
 764         } smb1;
 765         struct {
 766                 struct smbd_smb2_request_read_state {
 767                         struct smbd_smb2_request *req;
 768                         struct {
 769                                 uint8_t nbt[NBT_HDR_SIZE];
 770                                 bool done;
 771                         } hdr;
 772                         struct iovec vector;
 773                         bool doing_receivefile;
 774                         size_t min_recv_size;
 775                         size_t pktfull;
 776                         size_t pktlen;
 777                         uint8_t *pktbuf;
 778                 } request_read_state;
 779                 struct smbd_smb2_send_queue *send_queue;
 780                 size_t send_queue_len;
 781                 struct tevent_fd *fde;
 782                 bool negprot_2ff;
 783                 struct {
 784                         /* The event that makes us process our blocking lock queue */
 785                         struct tevent_timer *brl_timeout;
 786                         bool blocking_lock_unlock_state;
 787                 } locks;
 788                 struct smbd_smb2_request *requests;
 789                 /*
 790                  * seqnum_low is the lowest sequence number
 791                  * we will accept.
 792                  */
 793                 uint64_t seqnum_low;
 794                 /*
 795                  * seqnum_range is the range of credits we have
 796                  * granted from the sequence windows starting
 797                  * at seqnum_low.
 798                  *
 799                  * This gets incremented when new credits are
 800                  * granted and gets decremented when the
 801                  * lowest sequence number is consumed
 802                  * (when seqnum_low gets incremented).
 803                  */
 804                 uint16_t seqnum_range;
 805                 /*
 806                  * credits_grantedThe number of credits we have currently granted
 807                  * to the client.
 808                  *
 809                  * This gets incremented when new credits are
 810                  * granted and gets decremented when any credit
 811                  * is comsumed.
 812                  *
 813                  * Note: the decrementing is different compared
 814                  *       to seqnum_range.
 815                  */
 816                 uint16_t credits_granted;
 817                 /*
 818                  * The maximum number of credits we will ever
 819                  * grant to the client.
 820                  *
 821                  * Typically we will only grant 1/16th of
 822                  * max_credits.
 823                  *
 824                  * This is the "server max credits" parameter.
 825                  */
 826                 uint16_t max_credits;
 827                 /*
 828                  * a bitmap of size max_credits
 829                  */
 830                 struct bitmap *credits_bitmap;
 831                 bool supports_multicredit;
 832                 uint32_t max_trans;
 833                 uint32_t max_read;
 834                 uint32_t max_write;
 835         } smb2;
 836
 837         struct smbXsrv_connection *conn;
 838 };
 839
 840 extern struct smbXsrv_connection *global_smbXsrv_connection;
 841
 842 void smbd_init_globals(void);