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