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