source4/smb_server/smb_server.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Copyright (C) Andrew Tridgell              2003
   5    Copyright (C) James J Myers                2003 <myersjj@samba.org>
   6    Copyright (C) Stefan Metzmacher            2004
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 #include "request.h"
  24 #include "smbd/process_model.h"
  25
  26 /*
  27   this header declares the core context structures associated with smb
  28   sockets, tree connects, requests etc
  29
  30   the idea is that we will eventually get rid of all our global
  31   variables and instead store our stang from structures hanging off
  32   these basic elements
  33 */
  34
  35 /* the current user context for a request */
  36 struct smbsrv_session {
  37         struct smbsrv_session *prev, *next;
  38
  39         struct smbsrv_connection *smb_conn;
  40
  41         /* the vuid is used to specify the security context for this
  42            request. Note that this may not be the same vuid as we
  43            received on the wire (for example, for share mode or guest
  44            access) */
  45         uint16_t vuid;
  46
  47         struct gensec_security *gensec_ctx;
  48
  49         struct auth_session_info *session_info;
  50 };
  51
  52 /* we need a forward declaration of the ntvfs_ops strucutre to prevent
  53    include recursion */
  54 struct ntvfs_context;
  55
  56 struct smbsrv_tcon {
  57         struct smbsrv_tcon *next, *prev;
  58
  59         /* the server context that this was created on */
  60         struct smbsrv_connection *smb_conn;
  61
  62         uint16_t tid; /* an index passed over the wire (the TID) */
  63
  64         int service;
  65         BOOL read_only;
  66         BOOL admin_user;
  67
  68         /* the NTVFS context - see source/ntvfs/ for details */
  69         struct ntvfs_context *ntvfs_ctx;
  70
  71         /* the reported filesystem type */
  72         char *fs_type;
  73
  74         /* the reported device type */
  75         char *dev_type;
  76 };
  77
  78 /* a set of flags to control handling of request structures */
  79 #define REQ_CONTROL_LARGE     (1<<1) /* allow replies larger than max_xmit */
  80
  81 /* the context for a single SMB request. This is passed to any request-context
  82    functions */
  83 struct smbsrv_request {
  84         /* the smbsrv_connection needs a list of requests queued for send */
  85         struct smbsrv_request *next, *prev;
  86
  87         /* the server_context contains all context specific to this SMB socket */
  88         struct smbsrv_connection *smb_conn;
  89
  90         /* conn is only set for operations that have a valid TID */
  91         struct smbsrv_tcon *tcon;
  92
  93         /* the session context is derived from the vuid */
  94         struct smbsrv_session *session;
  95
  96         /* a set of flags to control usage of the request. See REQ_CONTROL_* */
  97         unsigned control_flags;
  98
  99         /* the smb pid is needed for locking contexts */
 100         uint16_t smbpid;
 101
 102         /* the flags from the SMB request, in raw form (host byte order) */
 103         uint16_t flags, flags2;
 104
 105         /* the system time when the request arrived */
 106         struct timeval request_time;
 107
 108         /* this can contain a fnum from an earlier part of a chained
 109          * message (such as an SMBOpenX), or -1 */
 110         int chained_fnum;
 111
 112         /* how far through the chain of SMB commands have we gone? */
 113         unsigned chain_count;
 114
 115         /* the sequence number for signing */
 116         uint64_t seq_num;
 117
 118         /* ntvfs per request async states */
 119         struct ntvfs_async_state *async_states;
 120
 121         struct request_buffer in;
 122         struct request_buffer out;
 123 };
 124
 125 /* this contains variables that should be used in % substitutions for
 126  * smb.conf parameters */
 127 struct substitute_context {
 128         char *remote_arch;
 129
 130         /* our local netbios name, as give to us by the client */
 131         char *local_machine;
 132
 133         /* the remote netbios name, as give to us by the client */
 134         char *remote_machine;
 135
 136         /* the select remote protocol */
 137         char *remote_proto;
 138
 139         /* the name of the client as should be displayed in
 140          * smbstatus. Can be an IP or a netbios name */
 141         char *client_name;
 142
 143         /* the username for %U */
 144         char *user_name;
 145 };
 146
 147 /* smb server context structure. This should contain all the state
 148  * information associated with a SMB server connection
 149  */
 150 struct smbsrv_connection {
 151         /* a count of the number of packets we have received. We
 152          * actually only care about zero/non-zero at this stage */
 153         //unsigned pkt_count;
 154
 155         /* context that has been negotiated between the client and server */
 156         struct {
 157                 /* have we already done the NBT session establishment? */
 158                 BOOL done_nbt_session;
 159
 160                 /* only one negprot per connection is allowed */
 161                 BOOL done_negprot;
 162
 163                 /* multiple session setups are allowed, but some parameters are
 164                    ignored in any but the first */
 165                 BOOL done_sesssetup;
 166
 167                 /*
 168                  * Size of data we can send to client. Set
 169                  *  by the client for all protocols above CORE.
 170                  *  Set by us for CORE protocol.
 171                  */
 172                 unsigned max_send; /* init to BUFFER_SIZE */
 173
 174                 /*
 175                  * Size of the data we can receive. Set by us.
 176                  * Can be modified by the max xmit parameter.
 177                  */
 178                 unsigned max_recv; /* init to BUFFER_SIZE */
 179
 180                 /* a guess at the remote architecture. Try not to rely on this - in almost
 181                    all cases using these values is the wrong thing to do */
 182                 enum remote_arch_types ra_type;
 183
 184                 /* the negotiatiated protocol */
 185                 enum protocol_types protocol;
 186
 187                 /* authentication context for multi-part negprot */
 188                 struct auth_context *auth_context;
 189
 190                 /* state of NTLMSSP auth */
 191                 struct auth_ntlmssp_state *ntlmssp_state;
 192
 193                 /* did we tell the client we support encrypted passwords? */
 194                 BOOL encrypted_passwords;
 195
 196                 /* did we send an extended security negprot reply? */
 197                 BOOL spnego_negotiated;
 198
 199                 /* client capabilities */
 200                 uint32_t client_caps;
 201
 202                 /* the timezone we sent to the client */
 203                 int zone_offset;
 204         } negotiate;
 205
 206         /* the context associated with open tree connects on a smb socket */
 207         struct {
 208                 /* list of open tree connects */
 209                 struct smbsrv_tcon *tcons;
 210
 211                 /* an id tree used to allocate tids */
 212                 struct idr_context *idtree_tid;
 213         } tree;
 214
 215         /* the context associated with open files on an smb socket */
 216 #if 0
 217         struct {
 218                 struct files_struct *files; /* open files */
 219
 220                 /* a fsp to use when chaining */
 221                 struct files_struct *chain_fsp;
 222
 223                 /* a fsp to use to save when breaking an oplock. */
 224                 struct files_struct *oplock_save_chain_fsp;
 225
 226                 /* how many files are open */
 227                 int files_used;
 228
 229                 /* limit for maximum open files */
 230                 int real_max_open_files;
 231         } file;
 232 #endif
 233         /* context associated with currently valid session setups */
 234         struct {
 235                 /* this holds info on session vuids that are already validated for this VC */
 236                 struct smbsrv_session *session_list;
 237                 uint16_t next_vuid; /* initialise to VUID_OFFSET */
 238                 int num_validated_vuids;
 239         } sessions;
 240
 241         /* the server_context holds a linked list of pending requests,
 242          * this is used for blocking locks and requests blocked due to oplock
 243          * break requests */
 244         struct _smbsrv_pending_request {
 245                 struct _smbsrv_pending_request *next, *prev;
 246
 247                 /* the request itself - needs to be freed */
 248                 struct smbsrv_request *request;
 249         } *requests;
 250 #if 0
 251         /* the timers context contains info on when we last did various
 252          * functions */
 253         struct {
 254                 /* when did we last do timeout processing? */
 255                 time_t last_timeout_processing;
 256
 257                 /* when did we last sent a keepalive */
 258                 time_t last_keepalive_sent;
 259
 260                 /* when we last checked the smb.conf for auto-reload */
 261                 time_t last_smb_conf_reload;
 262         } timers;
 263 #endif
 264         struct smb_signing_context signing;
 265
 266 //      struct substitute_context substitute;
 267
 268         struct server_connection *connection;
 269
 270         /* this holds a partially received request */
 271         struct smbsrv_request *partial_req;
 272
 273         /* this holds list of replies that are waiting to be sent
 274            to the client */
 275         struct smbsrv_request *pending_send;
 276
 277         /* a list of partially received transaction requests */
 278         struct smbsrv_trans_partial {
 279                 struct smbsrv_trans_partial *next, *prev;
 280                 struct smbsrv_request *req;
 281                 struct smb_trans2 *trans;
 282                 uint8_t command;
 283         } *trans_partial;
 284 };