source/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 state 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         /* Distinguish between a VUID allocated for the multi-pass
  52          * extended secrity session setup and one that is finished */
  53         BOOL finished_sesssetup;
  54
  55         struct timeval connect_time;
  56 };
  57
  58 /* we need a forward declaration of the ntvfs_ops strucutre to prevent
  59    include recursion */
  60 struct ntvfs_context;
  61
  62 struct smbsrv_tcon {
  63         struct smbsrv_tcon *next, *prev;
  64
  65         /* the server context that this was created on */
  66         struct smbsrv_connection *smb_conn;
  67
  68         uint16_t tid; /* an index passed over the wire (the TID) */
  69
  70         int service;
  71         BOOL read_only;
  72         BOOL admin_user;
  73
  74         /* the NTVFS context - see source/ntvfs/ for details */
  75         struct ntvfs_context *ntvfs_ctx;
  76
  77         /* the reported filesystem type */
  78         char *fs_type;
  79
  80         /* the reported device type */
  81         char *dev_type;
  82
  83         struct timeval connect_time;
  84 };
  85
  86 /* a set of flags to control handling of request structures */
  87 #define REQ_CONTROL_LARGE     (1<<1) /* allow replies larger than max_xmit */
  88
  89 /* the context for a single SMB request. This is passed to any request-context
  90    functions */
  91 struct smbsrv_request {
  92         /* the smbsrv_connection needs a list of requests queued for send */
  93         struct smbsrv_request *next, *prev;
  94
  95         /* the server_context contains all context specific to this SMB socket */
  96         struct smbsrv_connection *smb_conn;
  97
  98         /* conn is only set for operations that have a valid TID */
  99         struct smbsrv_tcon *tcon;
 100
 101         /* the session context is derived from the vuid */
 102         struct smbsrv_session *session;
 103
 104         /* a set of flags to control usage of the request. See REQ_CONTROL_* */
 105         unsigned control_flags;
 106
 107         /* the smb pid is needed for locking contexts */
 108         uint16_t smbpid;
 109
 110         /* the flags from the SMB request, in raw form (host byte order) */
 111         uint16_t flags, flags2;
 112
 113         /* the system time when the request arrived */
 114         struct timeval request_time;
 115
 116         /* this can contain a fnum from an earlier part of a chained
 117          * message (such as an SMBOpenX), or -1 */
 118         int chained_fnum;
 119
 120         /* how far through the chain of SMB commands have we gone? */
 121         unsigned chain_count;
 122
 123         /* the sequence number for signing */
 124         uint64_t seq_num;
 125
 126         /* ntvfs per request async states */
 127         struct ntvfs_async_state *async_states;
 128
 129         struct request_buffer in;
 130         struct request_buffer out;
 131 };
 132
 133 /* this contains variables that should be used in % substitutions for
 134  * smb.conf parameters */
 135 struct substitute_context {
 136         char *remote_arch;
 137
 138         /* our local netbios name, as give to us by the client */
 139         char *local_machine;
 140
 141         /* the remote netbios name, as give to us by the client */
 142         char *remote_machine;
 143
 144         /* the select remote protocol */
 145         char *remote_proto;
 146
 147         /* the name of the client as should be displayed in
 148          * smbstatus. Can be an IP or a netbios name */
 149         char *client_name;
 150
 151         /* the username for %U */
 152         char *user_name;
 153 };
 154
 155 /* smb server context structure. This should contain all the state
 156  * information associated with a SMB server connection
 157  */
 158 struct smbsrv_connection {
 159         /* context that has been negotiated between the client and server */
 160         struct {
 161                 /* have we already done the NBT session establishment? */
 162                 BOOL done_nbt_session;
 163
 164                 /* only one negprot per connection is allowed */
 165                 BOOL done_negprot;
 166
 167                 /* multiple session setups are allowed, but some parameters are
 168                    ignored in any but the first */
 169                 BOOL done_sesssetup;
 170
 171                 /*
 172                  * Size of data we can send to client. Set
 173                  *  by the client for all protocols above CORE.
 174                  *  Set by us for CORE protocol.
 175                  */
 176                 unsigned max_send; /* init to BUFFER_SIZE */
 177
 178                 /*
 179                  * Size of the data we can receive. Set by us.
 180                  * Can be modified by the max xmit parameter.
 181                  */
 182                 unsigned max_recv; /* init to BUFFER_SIZE */
 183
 184                 /* a guess at the remote architecture. Try not to rely on this - in almost
 185                    all cases using these values is the wrong thing to do */
 186                 enum remote_arch_types ra_type;
 187
 188                 /* the negotiatiated protocol */
 189                 enum protocol_types protocol;
 190
 191                 /* authentication context for multi-part negprot */
 192                 struct auth_context *auth_context;
 193
 194                 /* state of NTLMSSP auth */
 195                 struct auth_ntlmssp_state *ntlmssp_state;
 196
 197                 /* did we tell the client we support encrypted passwords? */
 198                 BOOL encrypted_passwords;
 199
 200                 /* did we send an extended security negprot reply? */
 201                 BOOL spnego_negotiated;
 202
 203                 /* client capabilities */
 204                 uint32_t client_caps;
 205
 206                 /* the timezone we sent to the client */
 207                 int zone_offset;
 208
 209                 /* NBT names only set when done_nbt_session is true */
 210                 struct nbt_name *called_name;
 211                 struct nbt_name *calling_name;
 212         } negotiate;
 213
 214         /* the context associated with open tree connects on a smb socket */
 215         struct {
 216                 /* list of open tree connects */
 217                 struct smbsrv_tcon *tcons;
 218
 219                 /* an id tree used to allocate tids */
 220                 struct idr_context *idtree_tid;
 221         } tree;
 222
 223         /* context associated with currently valid session setups */
 224         struct {
 225                 int num_validated_vuids;
 226
 227                 /* an id tree used to allocate vuids */
 228                 /* this holds info on session vuids that are already
 229                  * validated for this VC */
 230                 struct idr_context *idtree_vuid;
 231
 232                 /* also kept as a link list so it can be enumerated by
 233                    the management code */
 234                 struct smbsrv_session *list;
 235         } sessions;
 236
 237         /* the server_context holds a linked list of pending requests,
 238          * this is used for blocking locks and requests blocked due to oplock
 239          * break requests */
 240         struct _smbsrv_pending_request {
 241                 struct _smbsrv_pending_request *next, *prev;
 242
 243                 /* the request itself - needs to be freed */
 244                 struct smbsrv_request *request;
 245         } *requests;
 246
 247         struct smb_signing_context signing;
 248
 249         struct stream_connection *connection;
 250
 251         /* this holds a partially received request */
 252         struct smbsrv_request *partial_req;
 253
 254         /* this holds list of replies that are waiting to be sent
 255            to the client */
 256         struct smbsrv_request *pending_send;
 257
 258         /* a list of partially received transaction requests */
 259         struct smbsrv_trans_partial {
 260                 struct smbsrv_trans_partial *next, *prev;
 261                 struct smbsrv_request *req;
 262                 struct smb_trans2 *trans;
 263                 uint8_t command;
 264         } *trans_partial;
 265
 266         BOOL processing;
 267
 268         /* mark a connection for termination */
 269         BOOL terminate;
 270
 271         /* configuration parameters */
 272         struct {
 273                 enum security_types security;
 274                 BOOL nt_status_support;
 275         } config;
 276 };