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