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