source3/smbd/globals.h

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