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
  23 #if defined(WITH_AIO)
  24 struct aio_extra;
  25 extern struct aio_extra *aio_list_head;
  26 extern struct tevent_signal *aio_signal_event;
  27 extern int aio_pending_size;
  28 extern int outstanding_aio_calls;
  29 #endif
  30
  31 #ifdef USE_DMAPI
  32 struct smbd_dmapi_context;
  33 extern struct smbd_dmapi_context *dmapi_ctx;
  34 #endif
  35
  36 extern bool dfree_broken;
  37
  38 /* how many write cache buffers have been allocated */
  39 extern unsigned int allocated_write_caches;
  40
  41 /* A singleton cache to speed up searching by dev/inode. */
  42 struct fsp_singleton_cache {
  43         files_struct *fsp;
  44         struct file_id id;
  45 };
  46
  47 extern const struct mangle_fns *mangle_fns;
  48
  49 extern unsigned char *chartest;
  50 struct tdb_context;
  51 extern struct tdb_context *tdb_mangled_cache;
  52
  53 /*
  54   this determines how many characters are used from the original filename
  55   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
  56   The largest possible value is 6.
  57 */
  58 extern unsigned mangle_prefix;
  59
  60 struct msg_state;
  61 extern struct msg_state *smbd_msg_state;
  62
  63 extern bool logged_ioctl_message;
  64
  65 extern int trans_num;
  66
  67 extern time_t last_smb_conf_reload_time;
  68 extern time_t last_printer_reload_time;
  69 extern pid_t background_lpq_updater_pid;
  70
  71 /****************************************************************************
  72  structure to hold a linked list of queued messages.
  73  for processing.
  74 ****************************************************************************/
  75 extern uint32_t common_flags2;
  76
  77 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
  78 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
  79
  80 struct sec_ctx {
  81         struct security_unix_token ut;
  82         struct security_token *token;
  83 };
  84 /* A stack of security contexts.  We include the current context as being
  85    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
  86 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
  87 extern int sec_ctx_stack_ndx;
  88 extern bool become_uid_done;
  89 extern bool become_gid_done;
  90
  91 extern connection_struct *last_conn;
  92 extern uint16_t last_flags;
  93
  94 extern uint32_t global_client_caps;
  95
  96 extern uint16_t fnf_handle;
  97
  98 struct conn_ctx {
  99         connection_struct *conn;
 100         uint16 vuid;
 101 };
 102 /* A stack of current_user connection contexts. */
 103 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
 104 extern int conn_ctx_stack_ndx;
 105
 106 struct vfs_init_function_entry;
 107 extern struct vfs_init_function_entry *backends;
 108 extern char *sparse_buf;
 109 extern char *LastDir;
 110
 111 /* Current number of oplocks we have outstanding. */
 112 extern int32_t exclusive_oplocks_open;
 113 extern int32_t level_II_oplocks_open;
 114 extern struct kernel_oplocks *koplocks;
 115
 116 struct smbd_parent_context;
 117 extern struct smbd_parent_context *am_parent;
 118 extern struct memcache *smbd_memcache_ctx;
 119 extern bool exit_firsttime;
 120
 121 struct tstream_context;
 122 struct smbd_smb2_request;
 123 struct smbd_smb2_session;
 124 struct smbd_smb2_tcon;
 125
 126 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
 127
 128 void smbd_lock_socket(struct smbd_server_connection *sconn);
 129 void smbd_unlock_socket(struct smbd_server_connection *sconn);
 130
 131 NTSTATUS smbd_do_locking(struct smb_request *req,
 132                          files_struct *fsp,
 133                          uint8_t type,
 134                          int32_t timeout,
 135                          uint16_t num_ulocks,
 136                          struct smbd_lock_element *ulocks,
 137                          uint16_t num_locks,
 138                          struct smbd_lock_element *locks,
 139                          bool *async);
 140
 141 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
 142                                TALLOC_CTX *mem_ctx,
 143                                uint16_t info_level,
 144                                files_struct *fsp,
 145                                struct smb_filename *smb_fname,
 146                                bool delete_pending,
 147                                struct timespec write_time_ts,
 148                                struct ea_list *ea_list,
 149                                int lock_data_count,
 150                                char *lock_data,
 151                                uint16_t flags2,
 152                                unsigned int max_data_bytes,
 153                                char **ppdata,
 154                                unsigned int *pdata_size);
 155
 156 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
 157                                 struct smb_request *req,
 158                                 TALLOC_CTX *mem_ctx,
 159                                 uint16_t info_level,
 160                                 files_struct *fsp,
 161                                 struct smb_filename *smb_fname,
 162                                 char **ppdata, int total_data,
 163                                 int *ret_data_size);
 164
 165 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
 166                          TALLOC_CTX *mem_ctx,
 167                          uint16_t info_level,
 168                          uint16_t flags2,
 169                          unsigned int max_data_bytes,
 170                          char **ppdata,
 171                          int *ret_data_len);
 172
 173 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
 174                            struct dptr_struct *dirptr,
 175                            const char *mask,
 176                            uint32_t dirtype,
 177                            bool dont_descend,
 178                            bool ask_sharemode,
 179                            bool (*match_fn)(TALLOC_CTX *ctx,
 180                                             void *private_data,
 181                                             const char *dname,
 182                                             const char *mask,
 183                                             char **_fname),
 184                            bool (*mode_fn)(TALLOC_CTX *ctx,
 185                                            void *private_data,
 186                                            struct smb_filename *smb_fname,
 187                                            uint32_t *_mode),
 188                            void *private_data,
 189                            char **_fname,
 190                            struct smb_filename **_smb_fname,
 191                            uint32_t *_mode,
 192                            long *_prev_offset);
 193
 194 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
 195                                connection_struct *conn,
 196                                struct dptr_struct *dirptr,
 197                                uint16 flags2,
 198                                const char *path_mask,
 199                                uint32 dirtype,
 200                                int info_level,
 201                                int requires_resume_key,
 202                                bool dont_descend,
 203                                bool ask_sharemode,
 204                                uint8_t align,
 205                                bool do_pad,
 206                                char **ppdata,
 207                                char *base_data,
 208                                char *end_data,
 209                                int space_remaining,
 210                                bool *out_of_space,
 211                                bool *got_exact_match,
 212                                int *_last_entry_off,
 213                                struct ea_list *name_list);
 214
 215 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
 216                                     const struct smb_filename *smb_fname,
 217                                     bool file_existed,
 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 smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 224                                          const char *reason,
 225                                          const char *location);
 226 #define smbd_server_connection_terminate(sconn, reason) \
 227         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 228
 229 const char *smb2_opcode_name(uint16_t opcode);
 230 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
 231
 232 void reply_smb2002(struct smb_request *req, uint16_t choice);
 233 void reply_smb20ff(struct smb_request *req, uint16_t choice);
 234 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
 235                              const uint8_t *inbuf, size_t size);
 236
 237 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
 238                                     NTSTATUS status,
 239                                     DATA_BLOB *info,
 240                                     const char *location);
 241 #define smbd_smb2_request_error(req, status) \
 242         smbd_smb2_request_error_ex(req, status, NULL, __location__)
 243 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
 244                                    NTSTATUS status,
 245                                    DATA_BLOB body, DATA_BLOB *dyn,
 246                                    const char *location);
 247 #define smbd_smb2_request_done(req, body, dyn) \
 248         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
 249
 250 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
 251                                      uint64_t file_id_persistent,
 252                                      uint64_t file_id_volatile,
 253                                      uint8_t oplock_level);
 254
 255 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
 256                                          struct tevent_req *subreq,
 257                                          uint32_t defer_time);
 258
 259 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
 260 void remove_smb2_chained_fsp(files_struct *fsp);
 261
 262 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
 263                                         size_t expected_body_size);
 264
 265 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 266 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 267 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 268 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 269 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 270 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 271 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 272 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 273 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 274 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
 275 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 276 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
 277 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 278 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 279 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 280 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 281 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 282 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 283 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 284 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 285 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
 286 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
 287                                 struct tevent_immediate *im,
 288                                 void *private_data);
 289
 290 /* SMB1 -> SMB2 glue. */
 291 void send_break_message_smb2(files_struct *fsp, int level);
 292 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
 293 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
 294                                 struct smb_request *req,
 295                                 files_struct *fsp,
 296                                 int lock_timeout,
 297                                 int lock_num,
 298                                 uint64_t smblctx,
 299                                 enum brl_type lock_type,
 300                                 enum brl_flavour lock_flav,
 301                                 uint64_t offset,
 302                                 uint64_t count,
 303                                 uint64_t blocking_smblctx);
 304 void process_blocking_lock_queue_smb2(
 305         struct smbd_server_connection *sconn, struct timeval tv_curr);
 306 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
 307                         struct byte_range_lock *br_lck,
 308                         enum file_close_type close_type);
 309 /* From smbd/smb2_create.c */
 310 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
 311 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
 312                         struct timeval *p_request_time,
 313                         void **pp_state);
 314 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
 315                             uint64_t mid);
 316 void remove_deferred_open_message_smb2(
 317         struct smbd_server_connection *sconn, uint64_t mid);
 318 void schedule_deferred_open_message_smb2(
 319         struct smbd_server_connection *sconn, uint64_t mid);
 320 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
 321                         struct timeval request_time,
 322                         struct timeval timeout,
 323                         struct file_id id,
 324                         char *private_data,
 325                         size_t priv_len);
 326
 327 struct smbd_smb2_request {
 328         struct smbd_smb2_request *prev, *next;
 329
 330         TALLOC_CTX *mem_pool;
 331         struct smbd_smb2_request **parent;
 332
 333         struct smbd_server_connection *sconn;
 334
 335         /* the session the request operates on, maybe NULL */
 336         struct smbd_smb2_session *session;
 337         uint64_t last_session_id;
 338
 339         /* the tcon the request operates on, maybe NULL */
 340         struct smbd_smb2_tcon *tcon;
 341         uint32_t last_tid;
 342
 343         int current_idx;
 344         bool do_signing;
 345         struct tevent_timer *async_te;
 346         bool cancelled;
 347         bool compound_related;
 348
 349         /* fake smb1 request. */
 350         struct smb_request *smb1req;
 351         struct files_struct *compat_chain_fsp;
 352
 353         NTSTATUS next_status;
 354
 355         /*
 356          * The sub request for async backend calls.
 357          * This is used for SMB2 Cancel.
 358          */
 359         struct tevent_req *subreq;
 360
 361         struct {
 362                 /* the NBT header is not allocated */
 363                 uint8_t nbt_hdr[4];
 364                 /*
 365                  * vector[0] NBT
 366                  * .
 367                  * vector[1] SMB2
 368                  * vector[2] fixed body
 369                  * vector[3] dynamic body
 370                  * .
 371                  * .
 372                  * .
 373                  * vector[4] SMB2
 374                  * vector[5] fixed body
 375                  * vector[6] dynamic body
 376                  * .
 377                  * .
 378                  * .
 379                  */
 380                 struct iovec *vector;
 381                 int vector_count;
 382         } in;
 383         struct {
 384                 /* the NBT header is not allocated */
 385                 uint8_t nbt_hdr[4];
 386                 /*
 387                  * vector[0] NBT
 388                  * .
 389                  * vector[1] SMB2
 390                  * vector[2] fixed body
 391                  * vector[3] dynamic body
 392                  * .
 393                  * .
 394                  * .
 395                  * vector[4] SMB2
 396                  * vector[5] fixed body
 397                  * vector[6] dynamic body
 398                  * .
 399                  * .
 400                  * .
 401                  */
 402                 struct iovec *vector;
 403                 int vector_count;
 404         } out;
 405 };
 406
 407 struct smbd_server_connection;
 408
 409 struct smbd_smb2_session {
 410         struct smbd_smb2_session *prev, *next;
 411         struct smbd_server_connection *sconn;
 412         NTSTATUS status;
 413         uint64_t vuid;
 414         struct auth_ntlmssp_state *auth_ntlmssp_state;
 415         struct auth_session_info *session_info;
 416         DATA_BLOB session_key;
 417         bool do_signing;
 418
 419         user_struct *compat_vuser;
 420
 421         struct {
 422                 /* an id tree used to allocate tids */
 423                 struct idr_context *idtree;
 424
 425                 /* this is the limit of tid values for this connection */
 426                 uint32_t limit;
 427
 428                 struct smbd_smb2_tcon *list;
 429         } tcons;
 430 };
 431
 432 struct smbd_smb2_tcon {
 433         struct smbd_smb2_tcon *prev, *next;
 434         struct smbd_smb2_session *session;
 435         uint32_t tid;
 436         int snum;
 437         connection_struct *compat_conn;
 438 };
 439
 440 struct pending_message_list;
 441 struct pending_auth_data;
 442
 443 struct smbd_server_connection {
 444         int sock;
 445         const struct tsocket_address *local_address;
 446         const struct tsocket_address *remote_address;
 447         const char *remote_hostname;
 448         struct tevent_context *ev_ctx;
 449         struct messaging_context *msg_ctx;
 450         struct {
 451                 bool got_session;
 452         } nbt;
 453         bool using_smb2;
 454         int trans_num;
 455
 456         /*
 457          * Cache for calling poll(2) to avoid allocations in our
 458          * central event loop
 459          */
 460         struct pollfd *pfds;
 461
 462         struct files_struct *files;
 463         struct bitmap *file_bmap;
 464         int real_max_open_files;
 465         int files_used;
 466         struct fsp_singleton_cache fsp_fi_cache;
 467         unsigned long file_gen_counter;
 468         int first_file;
 469
 470         /* Try GENSEC hook */
 471         bool use_gensec_hook;
 472
 473         /* number of open connections (tcons) */
 474         int num_tcons_open;
 475
 476         struct pending_message_list *deferred_open_queue;
 477
 478
 479         /* open directory handles. */
 480         struct {
 481                 struct bitmap *dptr_bmap;
 482                 struct dptr_struct *dirptrs;
 483                 int dirhandles_open;
 484         } searches;
 485
 486         uint64_t num_requests;
 487
 488         struct {
 489                 struct fd_event *fde;
 490
 491                 struct {
 492                         /*
 493                          * fd for the fcntl lock mutexing access to our sock
 494                          */
 495                         int socket_lock_fd;
 496
 497                         /*
 498                          * fd for the trusted pipe from
 499                          * echo handler child
 500                          */
 501                         int trusted_fd;
 502
 503                         /*
 504                          * fde for the trusted_fd
 505                          */
 506                         struct fd_event *trusted_fde;
 507
 508                         /*
 509                          * Reference count for the fcntl lock to
 510                          * allow recursive locks.
 511                          */
 512                         int ref_count;
 513                 } echo_handler;
 514
 515                 struct {
 516                         bool encrypted_passwords;
 517                         bool spnego;
 518                         struct auth_context *auth_context;
 519                         bool done;
 520                         /*
 521                          * Size of the data we can receive. Set by us.
 522                          * Can be modified by the max xmit parameter.
 523                          */
 524                         int max_recv;
 525                 } negprot;
 526
 527                 struct {
 528                         uint16_t client_major;
 529                         uint16_t client_minor;
 530                         uint32_t client_cap_low;
 531                         uint32_t client_cap_high;
 532                 } unix_info;
 533
 534                 struct {
 535                         bool done_sesssetup;
 536                         /*
 537                          * Size of data we can send to client. Set
 538                          *  by the client for all protocols above CORE.
 539                          *  Set by us for CORE protocol.
 540                          */
 541                         int max_send;
 542                         uint16_t last_session_tag;
 543
 544                         /* users from session setup */
 545                         char *session_userlist;
 546                         /* workgroup from session setup. */
 547                         char *session_workgroup;
 548                         /*
 549                          * this holds info on user ids that are already
 550                          * validated for this VC
 551                          */
 552                         user_struct *validated_users;
 553                         uint16_t next_vuid;
 554                         int num_validated_vuids;
 555                 } sessions;
 556                 struct {
 557                         connection_struct *Connections;
 558                         /* number of open connections */
 559                         struct bitmap *bmap;
 560                 } tcons;
 561                 struct smb_signing_state *signing_state;
 562                 /* List to store partial SPNEGO auth fragments. */
 563                 struct pending_auth_data *pd_list;
 564
 565                 struct notify_mid_map *notify_mid_maps;
 566
 567                 struct {
 568                         /* dlink list we store pending lock records on. */
 569                         struct blocking_lock_record *blocking_lock_queue;
 570                         /* dlink list we move cancelled lock records onto. */
 571                         struct blocking_lock_record *blocking_lock_cancelled_queue;
 572
 573                         /* The event that makes us process our blocking lock queue */
 574                         struct timed_event *brl_timeout;
 575
 576                         bool blocking_lock_unlock_state;
 577                         bool blocking_lock_cancel_state;
 578                 } locks;
 579         } smb1;
 580         struct {
 581                 struct tevent_queue *recv_queue;
 582                 struct tevent_queue *send_queue;
 583                 struct tstream_context *stream;
 584                 bool negprot_2ff;
 585                 struct {
 586                         /* an id tree used to allocate vuids */
 587                         /* this holds info on session vuids that are already
 588                          * validated for this VC */
 589                         struct idr_context *idtree;
 590
 591                         /* this is the limit of vuid values for this connection */
 592                         uint64_t limit;
 593
 594                         struct smbd_smb2_session *list;
 595                 } sessions;
 596                 struct {
 597                         /* The event that makes us process our blocking lock queue */
 598                         struct timed_event *brl_timeout;
 599                         bool blocking_lock_unlock_state;
 600                 } locks;
 601                 struct smbd_smb2_request *requests;
 602                 uint64_t seqnum_low;
 603                 uint32_t credits_granted;
 604                 uint32_t max_credits;
 605                 uint32_t max_trans;
 606                 uint32_t max_read;
 607                 uint32_t max_write;
 608                 struct bitmap *credits_bitmap;
 609                 bool compound_related_in_progress;
 610         } smb2;
 611 };
 612
 613 extern struct smbd_server_connection *smbd_server_conn;
 614
 615 void smbd_init_globals(void);