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 extern struct bitmap *dptr_bmap;
  48 //struct dptr_struct;
  49 extern struct dptr_struct *dirptrs;
  50 extern int dirhandles_open;
  51
  52 /* how many write cache buffers have been allocated */
  53 extern unsigned int allocated_write_caches;
  54
  55 extern int real_max_open_files;
  56 extern struct bitmap *file_bmap;
  57 extern files_struct *Files;
  58 extern int files_used;
  59 /* A singleton cache to speed up searching by dev/inode. */
  60 struct fsp_singleton_cache {
  61         files_struct *fsp;
  62         struct file_id id;
  63 };
  64 extern struct fsp_singleton_cache fsp_fi_cache;
  65 extern unsigned long file_gen_counter;
  66 extern int first_file;
  67
  68 extern const struct mangle_fns *mangle_fns;
  69
  70 extern unsigned char *chartest;
  71 extern TDB_CONTEXT *tdb_mangled_cache;
  72
  73 /* these tables are used to provide fast tests for characters */
  74 extern unsigned char char_flags[256];
  75 /*
  76   this determines how many characters are used from the original filename
  77   in the 8.3 mangled name. A larger value leads to a weaker hash and more collisions.
  78   The largest possible value is 6.
  79 */
  80 extern unsigned mangle_prefix;
  81 extern unsigned char base_reverse[256];
  82
  83 extern char *last_from;
  84 extern char *last_to;
  85
  86 struct msg_state;
  87 extern struct msg_state *smbd_msg_state;
  88
  89 extern bool logged_ioctl_message;
  90
  91 extern int trans_num;
  92
  93 extern pid_t mypid;
  94 extern time_t last_smb_conf_reload_time;
  95 extern time_t last_printer_reload_time;
  96 /****************************************************************************
  97  structure to hold a linked list of queued messages.
  98  for processing.
  99 ****************************************************************************/
 100 struct pending_message_list;
 101 extern struct pending_message_list *deferred_open_queue;
 102 extern uint32_t common_flags2;
 103
 104 struct smb_srv_trans_enc_ctx;
 105 extern struct smb_srv_trans_enc_ctx *partial_srv_trans_enc_ctx;
 106 extern struct smb_srv_trans_enc_ctx *srv_trans_enc_ctx;
 107
 108 struct sec_ctx {
 109         UNIX_USER_TOKEN ut;
 110         NT_USER_TOKEN *token;
 111 };
 112 /* A stack of security contexts.  We include the current context as being
 113    the first one, so there is room for another MAX_SEC_CTX_DEPTH more. */
 114 extern struct sec_ctx sec_ctx_stack[MAX_SEC_CTX_DEPTH + 1];
 115 extern int sec_ctx_stack_ndx;
 116 extern bool become_uid_done;
 117 extern bool become_gid_done;
 118
 119 extern connection_struct *last_conn;
 120 extern uint16_t last_flags;
 121
 122 extern struct db_context *session_db_ctx_ptr;
 123
 124 extern uint32_t global_client_caps;
 125
 126 extern uint16_t fnf_handle;
 127
 128 struct conn_ctx {
 129         connection_struct *conn;
 130         uint16 vuid;
 131 };
 132 /* A stack of current_user connection contexts. */
 133 extern struct conn_ctx conn_ctx_stack[MAX_SEC_CTX_DEPTH];
 134 extern int conn_ctx_stack_ndx;
 135
 136 struct vfs_init_function_entry;
 137 extern struct vfs_init_function_entry *backends;
 138 extern char *sparse_buf;
 139 extern char *LastDir;
 140
 141 /* Current number of oplocks we have outstanding. */
 142 extern int32_t exclusive_oplocks_open;
 143 extern int32_t level_II_oplocks_open;
 144 extern bool global_client_failed_oplock_break;
 145 extern struct kernel_oplocks *koplocks;
 146
 147 extern int am_parent;
 148 extern int server_fd;
 149 extern struct event_context *smbd_event_ctx;
 150 extern struct messaging_context *smbd_msg_ctx;
 151 extern struct memcache *smbd_memcache_ctx;
 152 extern bool exit_firsttime;
 153 struct child_pid;
 154 extern struct child_pid *children;
 155 extern int num_children;
 156
 157 struct tstream_context;
 158 struct smbd_smb2_request;
 159 struct smbd_smb2_session;
 160 struct smbd_smb2_tcon;
 161
 162 DATA_BLOB negprot_spnego(void);
 163
 164 NTSTATUS smb2_signing_sign_pdu(DATA_BLOB session_key,
 165                                struct iovec *vector,
 166                                int count);
 167 NTSTATUS smb2_signing_check_pdu(DATA_BLOB session_key,
 168                                 const struct iovec *vector,
 169                                 int count);
 170
 171 struct smbd_lock_element {
 172         uint32_t smbpid;
 173         enum brl_type brltype;
 174         uint64_t offset;
 175         uint64_t count;
 176 };
 177
 178 NTSTATUS smbd_do_locking(struct smb_request *req,
 179                          files_struct *fsp,
 180                          uint8_t type,
 181                          int32_t timeout,
 182                          uint16_t num_ulocks,
 183                          struct smbd_lock_element *ulocks,
 184                          uint16_t num_locks,
 185                          struct smbd_lock_element *locks,
 186                          bool *async);
 187
 188 NTSTATUS smbd_do_qfilepathinfo(connection_struct *conn,
 189                                TALLOC_CTX *mem_ctx,
 190                                uint16_t info_level,
 191                                files_struct *fsp,
 192                                const struct smb_filename *smb_fname,
 193                                bool delete_pending,
 194                                struct timespec write_time_ts,
 195                                bool ms_dfs_link,
 196                                struct ea_list *ea_list,
 197                                int lock_data_count,
 198                                char *lock_data,
 199                                uint16_t flags2,
 200                                unsigned int max_data_bytes,
 201                                char **ppdata,
 202                                unsigned int *pdata_size);
 203
 204 NTSTATUS smbd_do_setfilepathinfo(connection_struct *conn,
 205                                 struct smb_request *req,
 206                                 TALLOC_CTX *mem_ctx,
 207                                 uint16_t info_level,
 208                                 files_struct *fsp,
 209                                 struct smb_filename *smb_fname,
 210                                 char **ppdata, int total_data,
 211                                 int *ret_data_size);
 212
 213 NTSTATUS smbd_do_qfsinfo(connection_struct *conn,
 214                          TALLOC_CTX *mem_ctx,
 215                          uint16_t info_level,
 216                          uint16_t flags2,
 217                          unsigned int max_data_bytes,
 218                          char **ppdata,
 219                          int *ret_data_len);
 220
 221 bool smbd_dirptr_get_entry(TALLOC_CTX *ctx,
 222                            struct dptr_struct *dirptr,
 223                            const char *mask,
 224                            uint32_t dirtype,
 225                            bool dont_descend,
 226                            bool ask_sharemode,
 227                            bool (*match_fn)(TALLOC_CTX *ctx,
 228                                             void *private_data,
 229                                             const char *dname,
 230                                             const char *mask,
 231                                             char **_fname),
 232                            bool (*mode_fn)(TALLOC_CTX *ctx,
 233                                            void *private_data,
 234                                            struct smb_filename *smb_fname,
 235                                            uint32_t *_mode),
 236                            void *private_data,
 237                            char **_fname,
 238                            struct smb_filename **_smb_fname,
 239                            uint32_t *_mode,
 240                            long *_prev_offset);
 241
 242 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 243                                          const char *reason,
 244                                          const char *location);
 245 #define smbd_server_connection_terminate(sconn, reason) \
 246         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 247
 248 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
 249
 250 void reply_smb2002(struct smb_request *req, uint16_t choice);
 251 void smbd_smb2_first_negprot(struct smbd_server_connection *conn,
 252                              const uint8_t *inbuf, size_t size);
 253
 254 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
 255                                     NTSTATUS status,
 256                                     DATA_BLOB *info,
 257                                     const char *location);
 258 #define smbd_smb2_request_error(req, status) \
 259         smbd_smb2_request_error_ex(req, status, NULL, __location__)
 260 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
 261                                    NTSTATUS status,
 262                                    DATA_BLOB body, DATA_BLOB *dyn,
 263                                    const char *location);
 264 #define smbd_smb2_request_done(req, body, dyn) \
 265         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
 266
 267 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
 268                                      uint64_t file_id_persistent,
 269                                      uint64_t file_id_volatile,
 270                                      uint8_t oplock_level);
 271
 272 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req);
 273
 274 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
 275 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
 276
 277 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
 278
 279 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 280 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 281 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 282 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 283 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 284 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 285 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 286 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 287 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 288 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 289 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 290 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 291 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 292 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 293 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 294 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 295 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 296 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 297
 298 struct smbd_smb2_request {
 299         struct smbd_smb2_request *prev, *next;
 300
 301         TALLOC_CTX *mem_pool;
 302         struct smbd_smb2_request **parent;
 303
 304         struct smbd_server_connection *conn;
 305
 306         /* the session the request operates on, maybe NULL */
 307         struct smbd_smb2_session *session;
 308
 309         /* the tcon the request operates on, maybe NULL */
 310         struct smbd_smb2_tcon *tcon;
 311
 312         int current_idx;
 313         bool do_signing;
 314
 315         struct files_struct *compat_chain_fsp;
 316
 317         NTSTATUS next_status;
 318
 319         struct {
 320                 /* the NBT header is not allocated */
 321                 uint8_t nbt_hdr[4];
 322                 /*
 323                  * vector[0] NBT
 324                  * .
 325                  * vector[1] SMB2
 326                  * vector[2] fixed body
 327                  * vector[3] dynamic body
 328                  * .
 329                  * .
 330                  * .
 331                  * vector[4] SMB2
 332                  * vector[5] fixed body
 333                  * vector[6] dynamic body
 334                  * .
 335                  * .
 336                  * .
 337                  */
 338                 struct iovec *vector;
 339                 int vector_count;
 340         } in;
 341         struct {
 342                 /* the NBT header is not allocated */
 343                 uint8_t nbt_hdr[4];
 344                 /*
 345                  * vector[0] NBT
 346                  * .
 347                  * vector[1] SMB2
 348                  * vector[2] fixed body
 349                  * vector[3] dynamic body
 350                  * .
 351                  * .
 352                  * .
 353                  * vector[4] SMB2
 354                  * vector[5] fixed body
 355                  * vector[6] dynamic body
 356                  * .
 357                  * .
 358                  * .
 359                  */
 360                 struct iovec *vector;
 361                 int vector_count;
 362         } out;
 363 };
 364
 365 struct smbd_server_connection;
 366
 367 struct smbd_smb2_session {
 368         struct smbd_smb2_session *prev, *next;
 369         struct smbd_server_connection *conn;
 370         NTSTATUS status;
 371         uint64_t vuid;
 372         AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
 373         struct auth_serversupplied_info *server_info;
 374         DATA_BLOB session_key;
 375         bool do_signing;
 376
 377         user_struct *compat_vuser;
 378
 379         struct {
 380                 /* an id tree used to allocate tids */
 381                 struct idr_context *idtree;
 382
 383                 /* this is the limit of tid values for this connection */
 384                 uint32_t limit;
 385
 386                 struct smbd_smb2_tcon *list;
 387         } tcons;
 388 };
 389
 390 struct smbd_smb2_tcon {
 391         struct smbd_smb2_tcon *prev, *next;
 392         struct smbd_smb2_session *session;
 393         uint32_t tid;
 394         int snum;
 395         connection_struct *compat_conn;
 396 };
 397
 398 struct pending_auth_data;
 399
 400 struct smbd_server_connection {
 401         struct {
 402                 bool got_session;
 403         } nbt;
 404         bool allow_smb2;
 405         struct {
 406                 struct fd_event *fde;
 407                 uint64_t num_requests;
 408                 struct {
 409                         bool encrypted_passwords;
 410                         bool spnego;
 411                         struct auth_context *auth_context;
 412                         bool done;
 413                         /*
 414                          * Size of the data we can receive. Set by us.
 415                          * Can be modified by the max xmit parameter.
 416                          */
 417                         int max_recv;
 418                 } negprot;
 419
 420                 struct {
 421                         bool done_sesssetup;
 422                         /*
 423                          * Size of data we can send to client. Set
 424                          *  by the client for all protocols above CORE.
 425                          *  Set by us for CORE protocol.
 426                          */
 427                         int max_send;
 428                         uint16_t last_session_tag;
 429
 430                         /* users from session setup */
 431                         char *session_userlist;
 432                         /* workgroup from session setup. */
 433                         char *session_workgroup;
 434                         /*
 435                          * this holds info on user ids that are already
 436                          * validated for this VC
 437                          */
 438                         user_struct *validated_users;
 439                         uint16_t next_vuid;
 440                         int num_validated_vuids;
 441 #ifdef HAVE_NETGROUP
 442                         char *my_yp_domain;
 443 #endif
 444                 } sessions;
 445                 struct {
 446                         connection_struct *Connections;
 447                         /* number of open connections */
 448                         struct bitmap *bmap;
 449                         int num_open;
 450                 } tcons;
 451                 struct smb_signing_state *signing_state;
 452                 /* List to store partial SPNEGO auth fragments. */
 453                 struct pending_auth_data *pd_list;
 454
 455                 struct notify_mid_map *notify_mid_maps;
 456         } smb1;
 457         struct {
 458                 struct tevent_context *event_ctx;
 459                 struct tevent_queue *recv_queue;
 460                 struct tevent_queue *send_queue;
 461                 struct tstream_context *stream;
 462                 struct {
 463                         /* an id tree used to allocate vuids */
 464                         /* this holds info on session vuids that are already
 465                          * validated for this VC */
 466                         struct idr_context *idtree;
 467
 468                         /* this is the limit of vuid values for this connection */
 469                         uint64_t limit;
 470
 471                         struct smbd_smb2_session *list;
 472                 } sessions;
 473                 struct smbd_smb2_request *requests;
 474         } smb2;
 475 };
 476
 477 extern struct smbd_server_connection *smbd_server_conn;
 478
 479 void smbd_init_globals(void);