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