source3/smbd/globals.h

   1 /*
   2    Unix SMB/Netbios implementation.
   3    smbd globals
   4    Copyright (C) Stefan Metzmacher 2009
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #if defined(WITH_AIO)
  21 struct aio_extra;
  22 extern struct aio_extra *aio_list_head;
  23 extern struct tevent_signal *aio_signal_event;
  24 extern int aio_pending_size;
  25 extern int outstanding_aio_calls;
  26 #endif
  27
  28 /* dlink list we store pending lock records on. */
  29 extern struct blocking_lock_record *blocking_lock_queue;
  30
  31 /* dlink list we move cancelled lock records onto. */
  32 extern struct blocking_lock_record *blocking_lock_cancelled_queue;
  33
  34 /* The event that makes us process our blocking lock queue */
  35 extern struct timed_event *brl_timeout;
  36
  37 extern bool blocking_lock_unlock_state;
  38 extern bool blocking_lock_cancel_state;
  39
  40 #ifdef USE_DMAPI
  41 struct smbd_dmapi_context;
  42 extern struct smbd_dmapi_context *dmapi_ctx;
  43 #endif
  44
  45 extern bool dfree_broken;
  46
  47 /* how many write cache buffers have been allocated */
  48 extern unsigned int allocated_write_caches;
  49
  50 extern int real_max_open_files;
  51 extern struct bitmap *file_bmap;
  52 extern files_struct *Files;
  53 extern int files_used;
  54 /* A singleton cache to speed up searching by dev/inode. */
  55 struct fsp_singleton_cache {
  56         files_struct *fsp;
  57         struct file_id id;
  58 };
  59 extern struct fsp_singleton_cache fsp_fi_cache;
  60 extern unsigned long file_gen_counter;
  61 extern int first_file;
  62
  63 extern const struct mangle_fns *mangle_fns;
  64
  65 extern unsigned char *chartest;
  66 extern TDB_CONTEXT *tdb_mangled_cache;
  67
  68 /* these tables are used to provide fast tests for characters */
  69 extern unsigned char char_flags[256];
  70 /*
  71   this determines how many characters are used from the original filename
  72   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
  73   The largest possible value is 6.
  74 */
  75 extern unsigned mangle_prefix;
  76 extern unsigned char base_reverse[256];
  77
  78 extern char *last_from;
  79 extern char *last_to;
  80
  81 struct msg_state;
  82 extern struct msg_state *smbd_msg_state;
  83
  84 extern bool logged_ioctl_message;
  85
  86 extern int trans_num;
  87
  88 extern pid_t mypid;
  89 extern time_t last_smb_conf_reload_time;
  90 extern time_t last_printer_reload_time;
  91 /****************************************************************************
  92  structure to hold a linked list of queued messages.
  93  for processing.
  94 ****************************************************************************/
  95 struct pending_message_list;
  96 extern struct pending_message_list *deferred_open_queue;
  97 extern uint32_t common_flags2;
  98
  99 struct smb_srv_trans_enc_ctx;
 100 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
 101 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
 102
 103 struct sec_ctx {
 104         UNIX_USER_TOKEN ut;
 105         NT_USER_TOKEN *token;
 106 };
 107 /* A stack of security contexts.  We include the current context as being
 108    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
 109 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
 110 extern int sec_ctx_stack_ndx;
 111 extern bool become_uid_done;
 112 extern bool become_gid_done;
 113
 114 extern connection_struct *last_conn;
 115 extern uint16_t last_flags;
 116
 117 extern uint32_t global_client_caps;
 118
 119 extern uint16_t fnf_handle;
 120
 121 struct conn_ctx {
 122         connection_struct *conn;
 123         uint16 vuid;
 124 };
 125 /* A stack of current_user connection contexts. */
 126 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
 127 extern int conn_ctx_stack_ndx;
 128
 129 struct vfs_init_function_entry;
 130 extern struct vfs_init_function_entry *backends;
 131 extern char *sparse_buf;
 132
 133 /* Current number of oplocks we have outstanding. */
 134 extern int32_t exclusive_oplocks_open;
 135 extern int32_t level_II_oplocks_open;
 136 extern bool global_client_failed_oplock_break;
 137 extern struct kernel_oplocks *koplocks;
 138
 139 extern int am_parent;
 140 extern int server_fd;
 141 extern struct event_context *smbd_event_ctx;
 142 extern struct messaging_context *smbd_msg_ctx;
 143 extern struct memcache *smbd_memcache_ctx;
 144 extern bool exit_firsttime;
 145 struct child_pid;
 146 extern struct child_pid *children;
 147 extern int num_children;
 148
 149 struct tstream_context;
 150 struct smbd_smb2_request;
 151 struct smbd_smb2_session;
 152 struct smbd_smb2_tcon;
 153
 154 DATA_BLOB negprot_spnego(void);
 155
 156 void smbd_lock_socket(struct smbd_server_connection *sconn);
 157 void smbd_unlock_socket(struct smbd_server_connection *sconn);
 158
 159 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
 160                                struct iovec *vector,
 161                                int count);
 162 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
 163                                 const struct iovec *vector,
 164                                 int count);
 165
 166 struct smbd_lock_element {
 167         uint32_t smbpid;
 168         enum brl_type brltype;
 169         uint64_t offset;
 170         uint64_t count;
 171 };
 172
 173 NTSTATUS smbd_do_locking(struct smb_request *req,
 174                          files_struct *fsp,
 175                          uint8_t type,
 176                          int32_t timeout,
 177                          uint16_t num_ulocks,
 178                          struct smbd_lock_element *ulocks,
 179                          uint16_t num_locks,
 180                          struct smbd_lock_element *locks,
 181                          bool *async);
 182
 183 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
 184                                TALLOC_CTX *mem_ctx,
 185                                uint16_t info_level,
 186                                files_struct *fsp,
 187                                struct smb_filename *smb_fname,
 188                                bool delete_pending,
 189                                struct timespec write_time_ts,
 190                                struct ea_list *ea_list,
 191                                int lock_data_count,
 192                                char *lock_data,
 193                                uint16_t flags2,
 194                                unsigned int max_data_bytes,
 195                                char **ppdata,
 196                                unsigned int *pdata_size);
 197
 198 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
 199                                 struct smb_request *req,
 200                                 TALLOC_CTX *mem_ctx,
 201                                 uint16_t info_level,
 202                                 files_struct *fsp,
 203                                 struct smb_filename *smb_fname,
 204                                 char **ppdata, int total_data,
 205                                 int *ret_data_size);
 206
 207 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
 208                          TALLOC_CTX *mem_ctx,
 209                          uint16_t info_level,
 210                          uint16_t flags2,
 211                          unsigned int max_data_bytes,
 212                          char **ppdata,
 213                          int *ret_data_len);
 214
 215 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
 216                            struct dptr_struct *dirptr,
 217                            const char *mask,
 218                            uint32_t dirtype,
 219                            bool dont_descend,
 220                            bool ask_sharemode,
 221                            bool (*match_fn)(TALLOC_CTX *ctx,
 222                                             void *private_data,
 223                                             const char *dname,
 224                                             const char *mask,
 225                                             char **_fname),
 226                            bool (*mode_fn)(TALLOC_CTX *ctx,
 227                                            void *private_data,
 228                                            struct smb_filename *smb_fname,
 229                                            uint32_t *_mode),
 230                            void *private_data,
 231                            char **_fname,
 232                            struct smb_filename **_smb_fname,
 233                            uint32_t *_mode,
 234                            long *_prev_offset);
 235
 236 bool smbd_dirptr_lanman2_entry(TALLOC_CTX *ctx,
 237                                connection_struct *conn,
 238                                struct dptr_struct *dirptr,
 239                                uint16 flags2,
 240                                const char *path_mask,
 241                                uint32 dirtype,
 242                                int info_level,
 243                                int requires_resume_key,
 244                                bool dont_descend,
 245                                bool ask_sharemode,
 246                                uint8_t align,
 247                                bool do_pad,
 248                                char **ppdata,
 249                                char *base_data,
 250                                char *end_data,
 251                                int space_remaining,
 252                                bool *out_of_space,
 253                                bool *got_exact_match,
 254                                int *_last_entry_off,
 255                                struct ea_list *name_list);
 256
 257 NTSTATUS smbd_check_open_rights(struct connection_struct *conn,
 258                                 const struct smb_filename *smb_fname,
 259                                 uint32_t access_mask,
 260                                 uint32_t *access_granted);
 261
 262 void smbd_notify_cancel_by_smbreq(struct smbd_server_connection *sconn,
 263                                   const struct smb_request *smbreq);
 264
 265 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 266                                          const char *reason,
 267                                          const char *location);
 268 #define smbd_server_connection_terminate(sconn, reason) \
 269         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 270
 271 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
 272
 273 void reply_smb2002(struct smb_request *req, uint16_t choice);
 274 void smbd_smb2_first_negprot(struct smbd_server_connection *sconn,
 275                              const uint8_t *inbuf, size_t size);
 276
 277 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
 278                                     NTSTATUS status,
 279                                     DATA_BLOB *info,
 280                                     const char *location);
 281 #define smbd_smb2_request_error(req, status) \
 282         smbd_smb2_request_error_ex(req, status, NULL, __location__)
 283 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
 284                                    NTSTATUS status,
 285                                    DATA_BLOB body, DATA_BLOB *dyn,
 286                                    const char *location);
 287 #define smbd_smb2_request_done(req, body, dyn) \
 288         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
 289
 290 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
 291                                      uint64_t file_id_persistent,
 292                                      uint64_t file_id_volatile,
 293                                      uint8_t oplock_level);
 294
 295 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req,
 296                                          struct tevent_req *subreq);
 297
 298 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
 299 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
 300
 301 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
 302
 303 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 304 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 305 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 306 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 307 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 308 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 309 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 310 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 311 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 312 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 313 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 314 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 315 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 316 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 317 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 318 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 319 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 320 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 321 NTSTATUS smbd_smb2_request_dispatch(struct smbd_smb2_request *req);
 322 void smbd_smb2_request_dispatch_immediate(struct tevent_context *ctx,
 323                                 struct tevent_immediate *im,
 324                                 void *private_data);
 325
 326 /* SMB1 -> SMB2 glue. */
 327 void send_break_message_smb2(files_struct *fsp, uint8_t level);
 328 bool push_blocking_lock_request_smb2( struct byte_range_lock *br_lck,
 329                                 struct smb_request *req,
 330                                 files_struct *fsp,
 331                                 int lock_timeout,
 332                                 int lock_num,
 333                                 uint32_t lock_pid,
 334                                 enum brl_type lock_type,
 335                                 enum brl_flavour lock_flav,
 336                                 uint64_t offset,
 337                                 uint64_t count,
 338                                 uint32_t blocking_pid);
 339 /* From smbd/smb2_create.c */
 340 bool get_deferred_open_message_state_smb2(struct smbd_smb2_request *smb2req,
 341                         struct timeval *p_request_time,
 342                         void **pp_state);
 343 bool open_was_deferred_smb2(uint64_t mid);
 344 void remove_deferred_open_message_smb2(uint64_t mid);
 345 void schedule_deferred_open_message_smb2(uint64_t mid);
 346 bool push_deferred_open_message_smb2(struct smbd_smb2_request *smb2req,
 347                         struct timeval request_time,
 348                         struct timeval timeout,
 349                         struct file_id id,
 350                         char *private_data,
 351                         size_t priv_len);
 352
 353 struct smbd_smb2_request {
 354         struct smbd_smb2_request *prev, *next;
 355
 356         TALLOC_CTX *mem_pool;
 357         struct smbd_smb2_request **parent;
 358
 359         struct smbd_server_connection *sconn;
 360
 361         /* the session the request operates on, maybe NULL */
 362         struct smbd_smb2_session *session;
 363
 364         /* the tcon the request operates on, maybe NULL */
 365         struct smbd_smb2_tcon *tcon;
 366
 367         int current_idx;
 368         bool do_signing;
 369         bool async;
 370         bool cancelled;
 371
 372         struct files_struct *compat_chain_fsp;
 373
 374         NTSTATUS next_status;
 375
 376         /*
 377          * The sub request for async backend calls.
 378          * This is used for SMB2 Cancel.
 379          */
 380         struct tevent_req *subreq;
 381
 382         struct {
 383                 /* the NBT header is not allocated */
 384                 uint8_t nbt_hdr[4];
 385                 /*
 386                  * vector[0] NBT
 387                  * .
 388                  * vector[1] SMB2
 389                  * vector[2] fixed body
 390                  * vector[3] dynamic body
 391                  * .
 392                  * .
 393                  * .
 394                  * vector[4] SMB2
 395                  * vector[5] fixed body
 396                  * vector[6] dynamic body
 397                  * .
 398                  * .
 399                  * .
 400                  */
 401                 struct iovec *vector;
 402                 int vector_count;
 403         } in;
 404         struct {
 405                 /* the NBT header is not allocated */
 406                 uint8_t nbt_hdr[4];
 407                 /*
 408                  * vector[0] NBT
 409                  * .
 410                  * vector[1] SMB2
 411                  * vector[2] fixed body
 412                  * vector[3] dynamic body
 413                  * .
 414                  * .
 415                  * .
 416                  * vector[4] SMB2
 417                  * vector[5] fixed body
 418                  * vector[6] dynamic body
 419                  * .
 420                  * .
 421                  * .
 422                  */
 423                 struct iovec *vector;
 424                 int vector_count;
 425         } out;
 426 };
 427
 428 struct smbd_server_connection;
 429
 430 struct smbd_smb2_session {
 431         struct smbd_smb2_session *prev, *next;
 432         struct smbd_server_connection *sconn;
 433         NTSTATUS status;
 434         uint64_t vuid;
 435         AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
 436         struct auth_serversupplied_info *server_info;
 437         DATA_BLOB session_key;
 438         bool do_signing;
 439
 440         user_struct *compat_vuser;
 441
 442         struct {
 443                 /* an id tree used to allocate tids */
 444                 struct idr_context *idtree;
 445
 446                 /* this is the limit of tid values for this connection */
 447                 uint32_t limit;
 448
 449                 struct smbd_smb2_tcon *list;
 450         } tcons;
 451 };
 452
 453 struct smbd_smb2_tcon {
 454         struct smbd_smb2_tcon *prev, *next;
 455         struct smbd_smb2_session *session;
 456         uint32_t tid;
 457         int snum;
 458         connection_struct *compat_conn;
 459 };
 460
 461 struct pending_auth_data;
 462
 463 struct smbd_server_connection {
 464         struct {
 465                 bool got_session;
 466         } nbt;
 467         bool allow_smb2;
 468         struct {
 469                 struct fd_event *fde;
 470
 471                 struct {
 472                         /*
 473                          * fd for the fcntl lock mutexing access to smbd_server_fd
 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 #ifdef HAVE_NETGROUP
 530                         char *my_yp_domain;
 531 #endif
 532                 } sessions;
 533                 struct {
 534                         connection_struct *Connections;
 535                         /* number of open connections */
 536                         struct bitmap *bmap;
 537                         int num_open;
 538                 } tcons;
 539                 struct smb_signing_state *signing_state;
 540                 /* List to store partial SPNEGO auth fragments. */
 541                 struct pending_auth_data *pd_list;
 542
 543                 struct notify_mid_map *notify_mid_maps;
 544
 545                 struct {
 546                         struct bitmap *dptr_bmap;
 547                         struct dptr_struct *dirptrs;
 548                         int dirhandles_open;
 549                 } searches;
 550         } smb1;
 551         struct {
 552                 struct tevent_context *event_ctx;
 553                 struct tevent_queue *recv_queue;
 554                 struct tevent_queue *send_queue;
 555                 struct tstream_context *stream;
 556                 struct {
 557                         /* an id tree used to allocate vuids */
 558                         /* this holds info on session vuids that are already
 559                          * validated for this VC */
 560                         struct idr_context *idtree;
 561
 562                         /* this is the limit of vuid values for this connection */
 563                         uint64_t limit;
 564
 565                         struct smbd_smb2_session *list;
 566                 } sessions;
 567                 struct smbd_smb2_request *requests;
 568         } smb2;
 569 };
 570
 571 extern struct smbd_server_connection *smbd_server_conn;
 572
 573 void smbd_init_globals(void);