source3/smbd/globals.h

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