source3/smbd/globals.h

   1 /*
   2    Unix SMB/Netbios implementation.
   3    smbd globals
   4    Copyright (C) Stefan Metzmacher 2009
   5    Copyright (C) Jeremy Allison 2010
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "system/select.h"
  22
  23 #if defined(HAVE_AIO)
  24 struct aio_extra;
  25 extern struct aio_extra *aio_list_head;
  26 extern struct tevent_signal *aio_signal_event;
  27 extern int aio_pending_size;
  28 extern int outstanding_aio_calls;
  29 #endif
  30
  31 #ifdef USE_DMAPI
  32 struct smbd_dmapi_context;
  33 extern struct smbd_dmapi_context *dmapi_ctx;
  34 #endif
  35
  36 extern bool dfree_broken;
  37
  38 /* how many write cache buffers have been allocated */
  39 extern unsigned int allocated_write_caches;
  40
  41 /* A singleton cache to speed up searching by dev/inode. */
  42 struct fsp_singleton_cache {
  43         files_struct *fsp;
  44         struct file_id id;
  45 };
  46
  47 extern const struct mangle_fns *mangle_fns;
  48
  49 extern unsigned char *chartest;
  50 struct tdb_context;
  51 extern struct tdb_context *tdb_mangled_cache;
  52
  53 /*
  54   this determines how many characters are used from the original filename
  55   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
  56   The largest possible value is 6.
  57 */
  58 extern unsigned mangle_prefix;
  59
  60 struct msg_state;
  61
  62 extern bool logged_ioctl_message;
  63
  64 extern int trans_num;
  65
  66 extern time_t last_smb_conf_reload_time;
  67 extern time_t last_printer_reload_time;
  68 extern pid_t background_lpq_updater_pid;
  69
  70 /****************************************************************************
  71  structure to hold a linked list of queued messages.
  72  for processing.
  73 ****************************************************************************/
  74 extern uint32_t common_flags2;
  75
  76 extern struct smb_trans_enc_state *partial_srv_trans_enc_ctx;
  77 extern struct smb_trans_enc_state *srv_trans_enc_ctx;
  78
  79 struct sec_ctx {
  80         struct security_unix_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         uint64_t 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 struct smbd_parent_context;
 111 extern struct smbd_parent_context *am_parent;
 112 extern struct memcache *smbd_memcache_ctx;
 113 extern bool exit_firsttime;
 114
 115 struct tstream_context;
 116 struct smbd_smb2_request;
 117 struct smbd_smb2_session;
 118 struct smbd_smb2_tcon;
 119
 120 DATA_BLOB negprot_spnego(TALLOC_CTX *ctx, struct smbd_server_connection *sconn);
 121
 122 void smbd_lock_socket(struct smbd_server_connection *sconn);
 123 void smbd_unlock_socket(struct smbd_server_connection *sconn);
 124
 125 NTSTATUS smbd_do_locking(struct smb_request *req,
 126                          files_struct *fsp,
 127                          uint8_t type,
 128                          int32_t timeout,
 129                          uint16_t num_ulocks,
 130                          struct smbd_lock_element *ulocks,
 131                          uint16_t num_locks,
 132                          struct smbd_lock_element *locks,
 133                          bool *async);
 134
 135 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
 136                                TALLOC_CTX *mem_ctx,
 137                                uint16_t info_level,
 138                                files_struct *fsp,
 139                                struct smb_filename *smb_fname,
 140                                bool delete_pending,
 141                                struct timespec write_time_ts,
 142                                struct ea_list *ea_list,
 143                                int lock_data_count,
 144                                char *lock_data,
 145                                uint16_t flags2,
 146                                unsigned int max_data_bytes,
 147                                char **ppdata,
 148                                unsigned int *pdata_size);
 149
 150 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
 151                                 struct smb_request *req,
 152                                 TALLOC_CTX *mem_ctx,
 153                                 uint16_t info_level,
 154                                 files_struct *fsp,
 155                                 struct smb_filename *smb_fname,
 156                                 char **ppdata, int total_data,
 157                                 int *ret_data_size);
 158
 159 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
 160                          TALLOC_CTX *mem_ctx,
 161                          uint16_t info_level,
 162                          uint16_t flags2,
 163                          unsigned int max_data_bytes,
 164                          char **ppdata,
 165                          int *ret_data_len);
 166
 167 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
 168                            struct dptr_struct *dirptr,
 169                            const char *mask,
 170                            uint32_t dirtype,
 171                            bool dont_descend,
 172                            bool ask_sharemode,
 173                            bool (*match_fn)(TALLOC_CTX *ctx,
 174                                             void *private_data,
 175                                             const char *dname,
 176                                             const char *mask,
 177                                             char **_fname),
 178                            bool (*mode_fn)(TALLOC_CTX *ctx,
 179                                            void *private_data,
 180                                            struct smb_filename *smb_fname,
 181                                            uint32_t *_mode),
 182                            void *private_data,
 183                            char **_fname,
 184                            struct smb_filename **_smb_fname,
 185                            uint32_t *_mode,
 186                            long *_prev_offset);
 187
 188 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
 189                                connection_struct *conn,
 190                                struct dptr_struct *dirptr,
 191                                uint16 flags2,
 192                                const char *path_mask,
 193                                uint32 dirtype,
 194                                int info_level,
 195                                int requires_resume_key,
 196                                bool dont_descend,
 197                                bool ask_sharemode,
 198                                uint8_t align,
 199                                bool do_pad,
 200                                char **ppdata,
 201                                char *base_data,
 202                                char *end_data,
 203                                int space_remaining,
 204                                bool *out_of_space,
 205                                bool *got_exact_match,
 206                                int *_last_entry_off,
 207                                struct ea_list *name_list);
 208
 209 NTSTATUS smbd_calculate_access_mask(connection_struct *conn,
 210                                     const struct smb_filename *smb_fname,
 211                                     uint32_t access_mask,
 212                                     uint32_t *access_mask_out);
 213
 214 void smbd_notify_cancel_by_smbreq(const struct smb_request *smbreq);
 215
 216 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 217                                          const char *reason,
 218                                          const char *location);
 219 #define smbd_server_connection_terminate(sconn, reason) \
 220         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 221
 222 const char *smb2_opcode_name(uint16_t opcode);
 223 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
 224
 225 void reply_smb2002(struct smb_request *req, uint16_t choice);
 226 void reply_smb20ff(struct smb_request *req, uint16_t choice);
 227 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
 228                              const uint8_t *inbuf, size_t size);
 229
 230 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
 231                                     NTSTATUS status,
 232                                     DATA_BLOB *info,
 233                                     const char *location);
 234 #define smbd_smb2_request_error(req, status) \
 235         smbd_smb2_request_error_ex(req, status, NULL, __location__)
 236 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
 237                                    NTSTATUS status,
 238                                    DATA_BLOB body, DATA_BLOB *dyn,
 239                                    const char *location);
 240 #define smbd_smb2_request_done(req, body, dyn) \
 241         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
 242
 243 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
 244                                      uint64_t file_id_persistent,
 245                                      uint64_t file_id_volatile,
 246                                      uint8_t oplock_level);
 247
 248 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
 249                                          struct tevent_req *subreq,
 250                                          uint32_t defer_time);
 251
 252 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
 253 void remove_smb2_chained_fsp(files_struct *fsp);
 254
 255 NTSTATUS smbd_smb2_request_verify_creditcharge(struct smbd_smb2_request *req,
 256                                                uint32_t data_length);
 257
 258 NTSTATUS smbd_smb2_request_verify_sizes(struct smbd_smb2_request *req,
 259                                         size_t expected_body_size);
 260
 261 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 262 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 263 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 264 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 265 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 266 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 267 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 268 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 269 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 270 NTSTATUS smb2_read_complete(struct tevent_req *req, ssize_t nread, int err);
 271 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 272 NTSTATUS smb2_write_complete(struct tevent_req *req, ssize_t nwritten, int err);
 273 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 274 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 275 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 276 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 277 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 278 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 279 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 280 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 281 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
 282 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
 283                                 struct tevent_immediate *im,
 284                                 void *private_data);
 285
 286 /* SMB1 -> SMB2 glue. */
 287 void send_break_message_smb2(files_struct *fsp, int level);
 288 struct blocking_lock_record *get_pending_smb2req_blr(struct smbd_smb2_request *smb2req);
 289 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
 290                                 struct smb_request *req,
 291                                 files_struct *fsp,
 292                                 int lock_timeout,
 293                                 int lock_num,
 294                                 uint64_t smblctx,
 295                                 enum brl_type lock_type,
 296                                 enum brl_flavour lock_flav,
 297                                 uint64_t offset,
 298                                 uint64_t count,
 299                                 uint64_t blocking_smblctx);
 300 void process_blocking_lock_queue_smb2(
 301         struct smbd_server_connection *sconn, struct timeval tv_curr);
 302 void cancel_pending_lock_requests_by_fid_smb2(files_struct *fsp,
 303                         struct byte_range_lock *br_lck,
 304                         enum file_close_type close_type);
 305 /* From smbd/smb2_create.c */
 306 int map_smb2_oplock_levels_to_samba(uint8_t in_oplock_level);
 307 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
 308                         struct timeval *p_request_time,
 309                         void **pp_state);
 310 bool open_was_deferred_smb2(struct smbd_server_connection *sconn,
 311                             uint64_t mid);
 312 void remove_deferred_open_message_smb2(
 313         struct smbd_server_connection *sconn, uint64_t mid);
 314 void schedule_deferred_open_message_smb2(
 315         struct smbd_server_connection *sconn, uint64_t mid);
 316 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
 317                         struct timeval request_time,
 318                         struct timeval timeout,
 319                         struct file_id id,
 320                         char *private_data,
 321                         size_t priv_len);
 322
 323 struct smbXsrv_connection {
 324         struct smbd_server_connection *sconn;
 325
 326         const struct tsocket_address *local_address;
 327         const struct tsocket_address *remote_address;
 328         const char *remote_hostname;
 329
 330         struct tevent_context *ev_ctx;
 331         struct messaging_context *msg_ctx;
 332
 333         enum protocol_types protocol;
 334
 335         struct {
 336                 struct {
 337                         uint32_t capabilities;
 338                         struct GUID guid;
 339                         uint16_t security_mode;
 340                         uint16_t num_dialects;
 341                         uint16_t *dialects;
 342                 } client;
 343                 struct {
 344                         uint32_t capabilities;
 345                         struct GUID guid;
 346                         uint16_t security_mode;
 347                         uint16_t dialect;
 348                         uint32_t max_trans;
 349                         uint32_t max_read;
 350                         uint32_t max_write;
 351                 } server;
 352         } smb2;
 353
 354         struct msg_state *msg_state;
 355
 356         uint64_t smbd_idle_profstamp;
 357 };
 358
 359 NTSTATUS smbXsrv_connection_init_tables(struct smbXsrv_connection *conn,
 360                                         enum protocol_types protocol);
 361
 362 struct smbd_smb2_request {
 363         struct smbd_smb2_request *prev, *next;
 364
 365         TALLOC_CTX *mem_pool;
 366         struct smbd_smb2_request **parent;
 367
 368         struct smbd_server_connection *sconn;
 369
 370         /* the session the request operates on, maybe NULL */
 371         struct smbd_smb2_session *session;
 372         uint64_t last_session_id;
 373
 374         /* the tcon the request operates on, maybe NULL */
 375         struct smbd_smb2_tcon *tcon;
 376         uint32_t last_tid;
 377
 378         int current_idx;
 379         bool do_signing;
 380         struct tevent_timer *async_te;
 381         bool cancelled;
 382         bool compound_related;
 383
 384         struct timeval request_time;
 385
 386         /* fake smb1 request. */
 387         struct smb_request *smb1req;
 388         struct files_struct *compat_chain_fsp;
 389
 390         NTSTATUS next_status;
 391
 392         /*
 393          * The sub request for async backend calls.
 394          * This is used for SMB2 Cancel.
 395          */
 396         struct tevent_req *subreq;
 397
 398         struct {
 399                 /* the NBT header is not allocated */
 400                 uint8_t nbt_hdr[4];
 401                 /*
 402                  * vector[0] NBT
 403                  * .
 404                  * vector[1] SMB2
 405                  * vector[2] fixed body
 406                  * vector[3] dynamic body
 407                  * .
 408                  * .
 409                  * .
 410                  * vector[4] SMB2
 411                  * vector[5] fixed body
 412                  * vector[6] dynamic body
 413                  * .
 414                  * .
 415                  * .
 416                  */
 417                 struct iovec *vector;
 418                 int vector_count;
 419         } in;
 420         struct {
 421                 /* the NBT header is not allocated */
 422                 uint8_t nbt_hdr[4];
 423                 /*
 424                  * vector[0] NBT
 425                  * .
 426                  * vector[1] SMB2
 427                  * vector[2] fixed body
 428                  * vector[3] dynamic body
 429                  * .
 430                  * .
 431                  * .
 432                  * vector[4] SMB2
 433                  * vector[5] fixed body
 434                  * vector[6] dynamic body
 435                  * .
 436                  * .
 437                  * .
 438                  */
 439                 struct iovec *vector;
 440                 int vector_count;
 441         } out;
 442 };
 443
 444 struct smbd_server_connection;
 445 struct user_struct;
 446
 447 struct smbd_smb2_session {
 448         struct smbd_smb2_session *prev, *next;
 449         struct smbd_server_connection *sconn;
 450         NTSTATUS status;
 451         uint64_t vuid;
 452         struct gensec_security *gensec_security;
 453         struct auth_session_info *session_info;
 454         DATA_BLOB session_key;
 455         bool do_signing;
 456
 457         struct user_struct *compat_vuser;
 458
 459         struct {
 460                 /* an id tree used to allocate tids */
 461                 struct idr_context *idtree;
 462
 463                 /* this is the limit of tid values for this connection */
 464                 uint32_t limit;
 465
 466                 struct smbd_smb2_tcon *list;
 467         } tcons;
 468 };
 469
 470 struct smbd_smb2_tcon {
 471         struct smbd_smb2_tcon *prev, *next;
 472         struct smbd_smb2_session *session;
 473         uint32_t tid;
 474         int snum;
 475         connection_struct *compat_conn;
 476 };
 477
 478 struct pending_message_list;
 479 struct pending_auth_data;
 480
 481 struct user_struct {
 482         struct user_struct *next, *prev;
 483         uint64_t vuid; /* Tag for this entry. */
 484
 485         char *session_keystr; /* used by utmp and pam session code.
 486                                  TDB key string */
 487         int homes_snum;
 488
 489         struct auth_session_info *session_info;
 490
 491         struct gensec_security *gensec_security;
 492 };
 493
 494 struct smbd_server_connection {
 495         int sock;
 496         const struct tsocket_address *local_address;
 497         const struct tsocket_address *remote_address;
 498         const char *remote_hostname;
 499         struct tevent_context *ev_ctx;
 500         struct messaging_context *msg_ctx;
 501         struct sys_notify_context *sys_notify_ctx;
 502         struct notify_context *notify_ctx;
 503         struct {
 504                 bool got_session;
 505         } nbt;
 506         bool using_smb2;
 507         int trans_num;
 508
 509         size_t num_users;
 510         struct user_struct *users;
 511
 512         size_t num_connections;
 513         struct connection_struct *connections;
 514
 515         size_t num_files;
 516         struct files_struct *files;
 517
 518         struct bitmap *file_bmap;
 519         int real_max_open_files;
 520         struct fsp_singleton_cache fsp_fi_cache;
 521         unsigned long file_gen_counter;
 522         int first_file;
 523
 524         struct pending_message_list *deferred_open_queue;
 525
 526
 527         /* open directory handles. */
 528         struct {
 529                 struct bitmap *dptr_bmap;
 530                 struct dptr_struct *dirptrs;
 531                 int dirhandles_open;
 532         } searches;
 533
 534         uint64_t num_requests;
 535
 536         /* Current number of oplocks we have outstanding. */
 537         struct {
 538                 int32_t exclusive_open;
 539                 int32_t level_II_open;
 540                 struct kernel_oplocks *kernel_ops;
 541         } oplocks;
 542
 543         struct {
 544                 struct fd_event *fde;
 545
 546                 struct {
 547                         /*
 548                          * fd for the fcntl lock mutexing access to our sock
 549                          */
 550                         int socket_lock_fd;
 551
 552                         /*
 553                          * fd for the trusted pipe from
 554                          * echo handler child
 555                          */
 556                         int trusted_fd;
 557
 558                         /*
 559                          * fde for the trusted_fd
 560                          */
 561                         struct fd_event *trusted_fde;
 562
 563                         /*
 564                          * Reference count for the fcntl lock to
 565                          * allow recursive locks.
 566                          */
 567                         int ref_count;
 568                 } echo_handler;
 569
 570                 struct {
 571                         bool encrypted_passwords;
 572                         bool spnego;
 573                         struct auth4_context *auth_context;
 574                         bool done;
 575                         /*
 576                          * Size of the data we can receive. Set by us.
 577                          * Can be modified by the max xmit parameter.
 578                          */
 579                         int max_recv;
 580                 } negprot;
 581
 582                 struct {
 583                         uint16_t client_major;
 584                         uint16_t client_minor;
 585                         uint32_t client_cap_low;
 586                         uint32_t client_cap_high;
 587                 } unix_info;
 588
 589                 struct {
 590                         bool done_sesssetup;
 591                         /*
 592                          * Size of data we can send to client. Set
 593                          *  by the client for all protocols above CORE.
 594                          *  Set by us for CORE protocol.
 595                          */
 596                         int max_send;
 597                         uint64_t last_session_tag;
 598
 599                         /*
 600                          * this holds info on user ids that are already
 601                          * validated for this VC
 602                          */
 603                         uint16_t next_vuid;
 604                 } sessions;
 605                 struct {
 606                         /* number of open connections */
 607                         struct bitmap *bmap;
 608                 } tcons;
 609                 struct smb_signing_state *signing_state;
 610
 611                 struct notify_mid_map *notify_mid_maps;
 612
 613                 struct {
 614                         /* dlink list we store pending lock records on. */
 615                         struct blocking_lock_record *blocking_lock_queue;
 616                         /* dlink list we move cancelled lock records onto. */
 617                         struct blocking_lock_record *blocking_lock_cancelled_queue;
 618
 619                         /* The event that makes us process our blocking lock queue */
 620                         struct timed_event *brl_timeout;
 621
 622                         bool blocking_lock_unlock_state;
 623                         bool blocking_lock_cancel_state;
 624                 } locks;
 625         } smb1;
 626         struct {
 627                 struct tevent_queue *recv_queue;
 628                 struct tevent_queue *send_queue;
 629                 struct tstream_context *stream;
 630                 bool negprot_2ff;
 631                 struct {
 632                         /* an id tree used to allocate vuids */
 633                         /* this holds info on session vuids that are already
 634                          * validated for this VC */
 635                         struct idr_context *idtree;
 636
 637                         /* this is the limit of vuid values for this connection */
 638                         uint64_t limit;
 639
 640                         struct smbd_smb2_session *list;
 641                 } sessions;
 642                 struct {
 643                         /* The event that makes us process our blocking lock queue */
 644                         struct timed_event *brl_timeout;
 645                         bool blocking_lock_unlock_state;
 646                 } locks;
 647                 struct smbd_smb2_request *requests;
 648                 uint64_t seqnum_low;
 649                 uint32_t credits_granted;
 650                 uint32_t max_credits;
 651                 uint32_t max_trans;
 652                 uint32_t max_read;
 653                 uint32_t max_write;
 654                 bool supports_multicredit;
 655                 struct bitmap *credits_bitmap;
 656                 bool compound_related_in_progress;
 657         } smb2;
 658
 659         struct smbXsrv_connection *conn;
 660 };
 661
 662 extern struct smbXsrv_connection *global_smbXsrv_connection;
 663
 664 void smbd_init_globals(void);