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 void smbd_server_connection_terminate_ex(struct smbd_server_connection *sconn,
 214                                          const char *reason,
 215                                          const char *location);
 216 #define smbd_server_connection_terminate(sconn, reason) \
 217         smbd_server_connection_terminate_ex(sconn, reason, __location__)
 218
 219 bool smbd_is_smb2_header(const uint8_t *inbuf, size_t size);
 220
 221 void reply_smb2002(struct smb_request *req, uint16_t choice);
 222 void smbd_smb2_first_negprot(struct smbd_server_connection *conn,
 223                              const uint8_t *inbuf, size_t size);
 224
 225 NTSTATUS smbd_smb2_request_error_ex(struct smbd_smb2_request *req,
 226                                     NTSTATUS status,
 227                                     DATA_BLOB *info,
 228                                     const char *location);
 229 #define smbd_smb2_request_error(req, status) \
 230         smbd_smb2_request_error_ex(req, status, NULL, __location__)
 231 NTSTATUS smbd_smb2_request_done_ex(struct smbd_smb2_request *req,
 232                                    NTSTATUS status,
 233                                    DATA_BLOB body, DATA_BLOB *dyn,
 234                                    const char *location);
 235 #define smbd_smb2_request_done(req, body, dyn) \
 236         smbd_smb2_request_done_ex(req, NT_STATUS_OK, body, dyn, __location__)
 237
 238 NTSTATUS smbd_smb2_send_oplock_break(struct smbd_server_connection *sconn,
 239                                      uint64_t file_id_persistent,
 240                                      uint64_t file_id_volatile,
 241                                      uint8_t oplock_level);
 242
 243 NTSTATUS smbd_smb2_request_pending_queue(struct smbd_smb2_request *req);
 244
 245 NTSTATUS smbd_smb2_request_check_session(struct smbd_smb2_request *req);
 246 NTSTATUS smbd_smb2_request_check_tcon(struct smbd_smb2_request *req);
 247
 248 struct smb_request *smbd_smb2_fake_smb_request(struct smbd_smb2_request *req);
 249
 250 NTSTATUS smbd_smb2_request_process_negprot(struct smbd_smb2_request *req);
 251 NTSTATUS smbd_smb2_request_process_sesssetup(struct smbd_smb2_request *req);
 252 NTSTATUS smbd_smb2_request_process_logoff(struct smbd_smb2_request *req);
 253 NTSTATUS smbd_smb2_request_process_tcon(struct smbd_smb2_request *req);
 254 NTSTATUS smbd_smb2_request_process_tdis(struct smbd_smb2_request *req);
 255 NTSTATUS smbd_smb2_request_process_create(struct smbd_smb2_request *req);
 256 NTSTATUS smbd_smb2_request_process_close(struct smbd_smb2_request *req);
 257 NTSTATUS smbd_smb2_request_process_flush(struct smbd_smb2_request *req);
 258 NTSTATUS smbd_smb2_request_process_read(struct smbd_smb2_request *req);
 259 NTSTATUS smbd_smb2_request_process_write(struct smbd_smb2_request *req);
 260 NTSTATUS smbd_smb2_request_process_lock(struct smbd_smb2_request *req);
 261 NTSTATUS smbd_smb2_request_process_ioctl(struct smbd_smb2_request *req);
 262 NTSTATUS smbd_smb2_request_process_keepalive(struct smbd_smb2_request *req);
 263 NTSTATUS smbd_smb2_request_process_find(struct smbd_smb2_request *req);
 264 NTSTATUS smbd_smb2_request_process_notify(struct smbd_smb2_request *req);
 265 NTSTATUS smbd_smb2_request_process_getinfo(struct smbd_smb2_request *req);
 266 NTSTATUS smbd_smb2_request_process_setinfo(struct smbd_smb2_request *req);
 267 NTSTATUS smbd_smb2_request_process_break(struct smbd_smb2_request *req);
 268
 269 struct smbd_smb2_request {
 270         struct smbd_smb2_request *prev, *next;
 271
 272         TALLOC_CTX *mem_pool;
 273         struct smbd_smb2_request **parent;
 274
 275         struct smbd_server_connection *conn;
 276
 277         /* the session the request operates on, maybe NULL */
 278         struct smbd_smb2_session *session;
 279
 280         /* the tcon the request operates on, maybe NULL */
 281         struct smbd_smb2_tcon *tcon;
 282
 283         int current_idx;
 284         bool do_signing;
 285
 286         struct files_struct *compat_chain_fsp;
 287
 288         NTSTATUS next_status;
 289
 290         struct {
 291                 /* the NBT header is not allocated */
 292                 uint8_t nbt_hdr[4];
 293                 /*
 294                  * vector[0] NBT
 295                  * .
 296                  * vector[1] SMB2
 297                  * vector[2] fixed body
 298                  * vector[3] dynamic body
 299                  * .
 300                  * .
 301                  * .
 302                  * vector[4] SMB2
 303                  * vector[5] fixed body
 304                  * vector[6] dynamic body
 305                  * .
 306                  * .
 307                  * .
 308                  */
 309                 struct iovec *vector;
 310                 int vector_count;
 311         } in;
 312         struct {
 313                 /* the NBT header is not allocated */
 314                 uint8_t nbt_hdr[4];
 315                 /*
 316                  * vector[0] NBT
 317                  * .
 318                  * vector[1] SMB2
 319                  * vector[2] fixed body
 320                  * vector[3] dynamic body
 321                  * .
 322                  * .
 323                  * .
 324                  * vector[4] SMB2
 325                  * vector[5] fixed body
 326                  * vector[6] dynamic body
 327                  * .
 328                  * .
 329                  * .
 330                  */
 331                 struct iovec *vector;
 332                 int vector_count;
 333         } out;
 334 };
 335
 336 struct smbd_server_connection;
 337
 338 struct smbd_smb2_session {
 339         struct smbd_smb2_session *prev, *next;
 340         struct smbd_server_connection *conn;
 341         NTSTATUS status;
 342         uint64_t vuid;
 343         AUTH_NTLMSSP_STATE *auth_ntlmssp_state;
 344         struct auth_serversupplied_info *server_info;
 345         DATA_BLOB session_key;
 346         bool do_signing;
 347
 348         user_struct *compat_vuser;
 349
 350         struct {
 351                 /* an id tree used to allocate tids */
 352                 struct idr_context *idtree;
 353
 354                 /* this is the limit of tid values for this connection */
 355                 uint32_t limit;
 356
 357                 struct smbd_smb2_tcon *list;
 358         } tcons;
 359 };
 360
 361 struct smbd_smb2_tcon {
 362         struct smbd_smb2_tcon *prev, *next;
 363         struct smbd_smb2_session *session;
 364         uint32_t tid;
 365         int snum;
 366         connection_struct *compat_conn;
 367 };
 368
 369 struct pending_auth_data;
 370
 371 struct smbd_server_connection {
 372         struct {
 373                 bool got_session;
 374         } nbt;
 375         bool allow_smb2;
 376         struct {
 377                 struct fd_event *fde;
 378                 uint64_t num_requests;
 379                 struct {
 380                         bool encrypted_passwords;
 381                         bool spnego;
 382                         struct auth_context *auth_context;
 383                         bool done;
 384                         /*
 385                          * Size of the data we can receive. Set by us.
 386                          * Can be modified by the max xmit parameter.
 387                          */
 388                         int max_recv;
 389                 } negprot;
 390
 391                 struct {
 392                         bool done_sesssetup;
 393                         /*
 394                          * Size of data we can send to client. Set
 395                          *  by the client for all protocols above CORE.
 396                          *  Set by us for CORE protocol.
 397                          */
 398                         int max_send;
 399                         uint16_t last_session_tag;
 400
 401                         /* users from session setup */
 402                         char *session_userlist;
 403                         /* workgroup from session setup. */
 404                         char *session_workgroup;
 405                         /*
 406                          * this holds info on user ids that are already
 407                          * validated for this VC
 408                          */
 409                         user_struct *validated_users;
 410                         uint16_t next_vuid;
 411                         int num_validated_vuids;
 412 #ifdef HAVE_NETGROUP
 413                         char *my_yp_domain;
 414 #endif
 415                 } sessions;
 416                 struct {
 417                         connection_struct *Connections;
 418                         /* number of open connections */
 419                         struct bitmap *bmap;
 420                         int num_open;
 421                 } tcons;
 422                 struct smb_signing_state *signing_state;
 423                 /* List to store partial SPNEGO auth fragments. */
 424                 struct pending_auth_data *pd_list;
 425
 426                 struct notify_mid_map *notify_mid_maps;
 427         } smb1;
 428         struct {
 429                 struct tevent_context *event_ctx;
 430                 struct tevent_queue *recv_queue;
 431                 struct tevent_queue *send_queue;
 432                 struct tstream_context *stream;
 433                 struct {
 434                         /* an id tree used to allocate vuids */
 435                         /* this holds info on session vuids that are already
 436                          * validated for this VC */
 437                         struct idr_context *idtree;
 438
 439                         /* this is the limit of vuid values for this connection */
 440                         uint64_t limit;
 441
 442                         struct smbd_smb2_session *list;
 443                 } sessions;
 444                 struct smbd_smb2_request *requests;
 445         } smb2;
 446 };
 447
 448 extern struct smbd_server_connection *smbd_server_conn;
 449
 450 void smbd_init_globals(void);