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 /* these tables are used to provide fast tests for characters */
  58 extern unsigned char char_flags[256];
  59 /*
  60   this determines how many characters are used from the original filename
  61   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
  62   The largest possible value is 6.
  63 */
  64 extern unsigned mangle_prefix;
  65 extern unsigned char base_reverse[256];
  66
  67 struct msg_state;
  68 extern struct msg_state *smbd_msg_state;
  69
  70 extern bool logged_ioctl_message;
  71
  72 extern int trans_num;
  73
  74 extern pid_t mypid;
  75 extern time_t last_smb_conf_reload_time;
  76 extern time_t last_printer_reload_time;
  77 /****************************************************************************
  78  structure to hold a linked list of queued messages.
  79  for processing.
  80 ****************************************************************************/
  81 struct pending_message_list;
  82 extern struct pending_message_list *deferred_open_queue;
  83 extern uint32_t common_flags2;
  84
  85 struct smb_srv_trans_enc_ctx;
  86 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
  87 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
  88
  89 struct sec_ctx {
  90         UNIX_USER_TOKEN ut;
  91         NT_USER_TOKEN *token;
  92 };
  93 /* A stack of security contexts.  We include the current context as being
  94    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
  95 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
  96 extern int sec_ctx_stack_ndx;
  97 extern bool become_uid_done;
  98 extern bool become_gid_done;
  99
 100 extern connection_struct *last_conn;
 101 extern uint16_t last_flags;
 102
 103 extern uint32_t global_client_caps;
 104
 105 extern uint16_t fnf_handle;
 106
 107 struct conn_ctx {
 108         connection_struct *conn;
 109         uint16 vuid;
 110 };
 111 /* A stack of current_user connection contexts. */
 112 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
 113 extern int conn_ctx_stack_ndx;
 114
 115 struct vfs_init_function_entry;
 116 extern struct vfs_init_function_entry *backends;
 117 extern char *sparse_buf;
 118
 119 /* Current number of oplocks we have outstanding. */
 120 extern int32_t exclusive_oplocks_open;
 121 extern int32_t level_II_oplocks_open;
 122 extern struct kernel_oplocks *koplocks;
 123
 124 extern int am_parent;
 125 extern int server_fd;
 126 extern struct event_context *smbd_event_ctx;
 127 extern struct messaging_context *smbd_msg_ctx;
 128 extern struct memcache *smbd_memcache_ctx;
 129 extern bool exit_firsttime;
 130 struct child_pid;
 131 extern struct child_pid *children;
 132 extern int num_children;
 133
 134 struct tstream_context;
 135 struct smbd_smb2_request;
 136 struct smbd_smb2_session;
 137 struct smbd_smb2_tcon;
 138
 139 DATA_BLOB negprot_spnego(void);
 140
 141 void smbd_lock_socket(struct smbd_server_connection *sconn);
 142 void smbd_unlock_socket(struct smbd_server_connection *sconn);
 143
 144 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
 145                                struct iovec *vector,
 146                                int count);
 147 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
 148                                 const struct iovec *vector,
 149                                 int count);
 150
 151 NTSTATUS smbd_do_locking(struct smb_request *req,
 152                          files_struct *fsp,
 153                          uint8_t type,
 154                          int32_t timeout,
 155                          uint16_t num_ulocks,
 156                          struct smbd_lock_element *ulocks,
 157                          uint16_t num_locks,
 158                          struct smbd_lock_element *locks,
 159                          bool *async);
 160
 161 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
 162                                TALLOC_CTX *mem_ctx,
 163                                uint16_t info_level,
 164                                files_struct *fsp,
 165                                struct smb_filename *smb_fname,
 166                                bool delete_pending,
 167                                struct timespec write_time_ts,
 168                                struct ea_list *ea_list,
 169                                int lock_data_count,
 170                                char *lock_data,
 171                                uint16_t flags2,
 172                                unsigned int max_data_bytes,
 173                                char **ppdata,
 174                                unsigned int *pdata_size);
 175
 176 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
 177                                 struct smb_request *req,
 178                                 TALLOC_CTX *mem_ctx,
 179                                 uint16_t info_level,
 180                                 files_struct *fsp,
 181                                 struct smb_filename *smb_fname,
 182                                 char **ppdata, int total_data,
 183                                 int *ret_data_size);
 184
 185 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
 186                          TALLOC_CTX *mem_ctx,
 187                          uint16_t info_level,
 188                          uint16_t flags2,
 189                          unsigned int max_data_bytes,
 190                          char **ppdata,
 191                          int *ret_data_len);
 192
 193 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
 194                            struct dptr_struct *dirptr,
 195                            const char *mask,
 196                            uint32_t dirtype,
 197                            bool dont_descend,
 198                            bool ask_sharemode,
 199                            bool (*match_fn)(TALLOC_CTX *ctx,
 200                                             void *private_data,
 201                                             const char *dname,
 202                                             const char *mask,
 203                                             char **_fname),
 204                            bool (*mode_fn)(TALLOC_CTX *ctx,
 205                                            void *private_data,
 206                                            struct smb_filename *smb_fname,
 207                                            uint32_t *_mode),
 208                            void *private_data,
 209                            char **_fname,
 210                            struct smb_filename **_smb_fname,
 211                            uint32_t *_mode,
 212                            long *_prev_offset);
 213
 214 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
 215                                connection_struct *conn,
 216                                struct dptr_struct *dirptr,
 217                                uint16 flags2,
 218                                const char *path_mask,
 219                                uint32 dirtype,
 220                                int info_level,
 221                                int requires_resume_key,
 222                                bool dont_descend,
 223                                bool ask_sharemode,
 224                                uint8_t align,
 225                                bool do_pad,
 226                                char **ppdata,
 227                                char *base_data,
 228                                char *end_data,
 229                                int space_remaining,
 230                                bool *out_of_space,
 231                                bool *got_exact_match,
 232                                int *_last_entry_off,
 233                                struct ea_list *name_list);
 234
 235 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
 236                                 const struct smb_filename *smb_fname,
 237                                 uint32_t access_mask,
 238                                 uint32_t *access_granted);
 239
 240 void smbd_notify_cancel_by_smbreq(struct smbd_server_connection *sconn,
 241                                   const struct smb_request *smbreq);
 242
 243 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 244                                          const char *reason,
 245                                          const char *location);
 246 #define smbd_server_connection_terminate(sconn, reason) \
 247         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 248
 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
 281 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 282 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 283 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 284 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 285 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 286 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 287 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 288 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 289 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 290 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 291 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 292 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 293 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 294 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 295 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 296 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 297 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 298 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 299 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
 300 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
 301                                 struct tevent_immediate *im,
 302                                 void *private_data);
 303
 304 /* SMB1 -> SMB2 glue. */
 305 void send_break_message_smb2(files_struct *fsp, int level);
 306 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
 307 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
 308                                 struct smb_request *req,
 309                                 files_struct *fsp,
 310                                 int lock_timeout,
 311                                 int lock_num,
 312                                 uint64_t smblctx,
 313                                 enum brl_type lock_type,
 314                                 enum brl_flavour lock_flav,
 315                                 uint64_t offset,
 316                                 uint64_t count,
 317                                 uint64_t blocking_smblctx);
 318 void process_blocking_lock_queue_smb2(struct timeval tv_curr);
 319 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
 320                         struct byte_range_lock *br_lck,
 321                         enum file_close_type close_type);
 322 /* From smbd/smb2_create.c */
 323 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
 324 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
 325                         struct timeval *p_request_time,
 326                         void **pp_state);
 327 bool open_was_deferred_smb2(uint64_t mid);
 328 void remove_deferred_open_message_smb2(uint64_t mid);
 329 void schedule_deferred_open_message_smb2(uint64_t mid);
 330 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
 331                         struct timeval request_time,
 332                         struct timeval timeout,
 333                         struct file_id id,
 334                         char *private_data,
 335                         size_t priv_len);
 336
 337 struct smbd_smb2_request {
 338         struct smbd_smb2_request *prev, *next;
 339
 340         TALLOC_CTX *mem_pool;
 341         struct smbd_smb2_request **parent;
 342
 343         struct smbd_server_connection *sconn;
 344
 345         /* the session the request operates on, maybe NULL */
 346         struct smbd_smb2_session *session;
 347
 348         /* the tcon the request operates on, maybe NULL */
 349         struct smbd_smb2_tcon *tcon;
 350
 351         int current_idx;
 352         bool do_signing;
 353         bool async;
 354         bool cancelled;
 355
 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_serversupplied_info *server_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_auth_data;
 446
 447 struct smbd_server_connection {
 448         const struct tsocket_address *local_address;
 449         const struct tsocket_address *remote_address;
 450         struct {
 451                 bool got_session;
 452         } nbt;
 453         bool allow_smb2;
 454         struct {
 455                 struct fd_event *fde;
 456
 457                 struct {
 458                         /*
 459                          * fd for the fcntl lock mutexing access to smbd_server_fd
 460                          */
 461                         int socket_lock_fd;
 462
 463                         /*
 464                          * fd for the trusted pipe from
 465                          * echo handler child
 466                          */
 467                         int trusted_fd;
 468
 469                         /*
 470                          * fde for the trusted_fd
 471                          */
 472                         struct fd_event *trusted_fde;
 473
 474                         /*
 475                          * Reference count for the fcntl lock to
 476                          * allow recursive locks.
 477                          */
 478                         int ref_count;
 479                 } echo_handler;
 480
 481                 uint64_t num_requests;
 482                 struct {
 483                         bool encrypted_passwords;
 484                         bool spnego;
 485                         struct auth_context *auth_context;
 486                         bool done;
 487                         /*
 488                          * Size of the data we can receive. Set by us.
 489                          * Can be modified by the max xmit parameter.
 490                          */
 491                         int max_recv;
 492                 } negprot;
 493
 494                 struct {
 495                         bool done_sesssetup;
 496                         /*
 497                          * Size of data we can send to client. Set
 498                          *  by the client for all protocols above CORE.
 499                          *  Set by us for CORE protocol.
 500                          */
 501                         int max_send;
 502                         uint16_t last_session_tag;
 503
 504                         /* users from session setup */
 505                         char *session_userlist;
 506                         /* workgroup from session setup. */
 507                         char *session_workgroup;
 508                         /*
 509                          * this holds info on user ids that are already
 510                          * validated for this VC
 511                          */
 512                         user_struct *validated_users;
 513                         uint16_t next_vuid;
 514                         int num_validated_vuids;
 515                 } sessions;
 516                 struct {
 517                         connection_struct *Connections;
 518                         /* number of open connections */
 519                         struct bitmap *bmap;
 520                         int num_open;
 521                 } tcons;
 522                 struct smb_signing_state *signing_state;
 523                 /* List to store partial SPNEGO auth fragments. */
 524                 struct pending_auth_data *pd_list;
 525
 526                 struct notify_mid_map *notify_mid_maps;
 527
 528                 struct {
 529                         struct bitmap *dptr_bmap;
 530                         struct dptr_struct *dirptrs;
 531                         int dirhandles_open;
 532                 } searches;
 533                 struct {
 534                         /* dlink list we store pending lock records on. */
 535                         struct blocking_lock_record *blocking_lock_queue;
 536                         /* dlink list we move cancelled lock records onto. */
 537                         struct blocking_lock_record *blocking_lock_cancelled_queue;
 538
 539                         /* The event that makes us process our blocking lock queue */
 540                         struct timed_event *brl_timeout;
 541
 542                         bool blocking_lock_unlock_state;
 543                         bool blocking_lock_cancel_state;
 544                 } locks;
 545         } smb1;
 546         struct {
 547                 struct tevent_context *event_ctx;
 548                 struct tevent_queue *recv_queue;
 549                 struct tevent_queue *send_queue;
 550                 struct tstream_context *stream;
 551                 struct {
 552                         /* an id tree used to allocate vuids */
 553                         /* this holds info on session vuids that are already
 554                          * validated for this VC */
 555                         struct idr_context *idtree;
 556
 557                         /* this is the limit of vuid values for this connection */
 558                         uint64_t limit;
 559
 560                         struct smbd_smb2_session *list;
 561                 } sessions;
 562                 struct {
 563                         /* The event that makes us process our blocking lock queue */
 564                         struct timed_event *brl_timeout;
 565                         bool blocking_lock_unlock_state;
 566                 } locks;
 567                 struct smbd_smb2_request *requests;
 568                 uint64_t credits_granted;
 569         } smb2;
 570 };
 571
 572 extern struct smbd_server_connection *smbd_server_conn;
 573
 574 void smbd_init_globals(void);