path: root/source4/smb_server/smb_server.h

/* 
   Unix SMB/CIFS implementation.
   
   Copyright (C) Andrew Tridgell              2003
   Copyright (C) James J Myers 		      2003 <myersjj@samba.org>
   Copyright (C) Stefan Metzmacher            2004
   
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

/*
  this header declares the core context structures associated with smb
  sockets, tree connects, requests etc

  the idea is that we will eventually get rid of all our global
  variables and instead store our stang from structures hanging off
  these basic elements
*/

/* the current user context for a request */
struct smbsrv_session {
	struct smbsrv_session *prev, *next;

	struct smbsrv_connection *smb_conn;

	/* the vuid is used to specify the security context for this
	   request. Note that this may not be the same vuid as we
	   received on the wire (for example, for share mode or guest
	   access) */
	uint16_t vuid;

	struct gensec_security *gensec_ctx;

	struct auth_session_info *session_info;
};

/* we need a forward declaration of the ntvfs_ops strucutre to prevent
   include recursion */
struct ntvfs_context;

struct smbsrv_tcon {
	struct smbsrv_tcon *next, *prev;

	/* the server context that this was created on */
	struct smbsrv_connection *smb_conn;

	uint16_t cnum; /* an index passed over the wire (the TID) */
	int service;
	BOOL read_only;
	BOOL admin_user;

	/* the NTVFS context - see source/ntvfs/ for details */
	struct ntvfs_context *ntvfs_ctx;

	/* the reported filesystem type */
	char *fs_type;

	/* the reported device type */
	char *dev_type;
};

/* the context for a single SMB request. This is passed to any request-context 
   functions */
struct smbsrv_request {
	/* the server_context contains all context specific to this SMB socket */
	struct smbsrv_connection *smb_conn;

	/* conn is only set for operations that have a valid TID */
	struct smbsrv_tcon *tcon;

	/* the session context is derived from the vuid */
	struct smbsrv_session *session;

	/* a set of flags to control usage of the request. See REQ_CONTROL_* */
	unsigned control_flags;

	/* the smb pid is needed for locking contexts */
	uint16_t smbpid;

	/* the flags from the SMB request, in raw form (host byte order) */
	uint16_t flags, flags2;

	/* the system time when the request arrived */
	struct timeval request_time;

	/* this can contain a fnum from an earlier part of a chained
	 * message (such as an SMBOpenX), or -1 */
	int chained_fnum;

	/* how far through the chain of SMB commands have we gone? */
	unsigned chain_count;

	/* the sequence number for signing */
	uint64_t seq_num;

	/* the async structure allows backend functions to delay
	   replying to requests. To use this, the front end must set
	   async.send_fn to a function to be called by the backend
	   when the reply is finally ready to be sent. The backend
	   must set async.status to the status it wants in the
	   reply. The backend must set the REQ_CONTROL_ASYNC
	   control_flag on the request to indicate that it wishes to
	   delay the reply

	   If REQ_CONTROL_MAY_ASYNC is not set then the backend cannot
	   ask for a delayed reply for this request

	   note that the async.private pointer is private to the front
	   end not the backend. The backend must not change it.
	*/
	struct {
		void (*send_fn)(struct smbsrv_request *);
		void *private;
		NTSTATUS status;
	} async;

	struct request_buffer in;
	struct request_buffer out;
};

/* this contains variables that should be used in % substitutions for
 * smb.conf parameters */
struct substitute_context {
	char *remote_arch;

	/* our local netbios name, as give to us by the client */
	char *local_machine;

	/* the remote netbios name, as give to us by the client */
	char *remote_machine;

	/* the select remote protocol */
	char *remote_proto;	

	/* the name of the client as should be displayed in
	 * smbstatus. Can be an IP or a netbios name */
	char *client_name; 

	/* the username for %U */
	char *user_name;
};

#include "smbd/process_model.h"

/* smb server context structure. This should contain all the state
 * information associated with a SMB server connection 
 */
struct smbsrv_connection {
	/* a count of the number of packets we have received. We
	 * actually only care about zero/non-zero at this stage */
	unsigned pkt_count;

	/* context that has been negotiated between the client and server */
	struct {
		/* have we already done the NBT session establishment? */
		BOOL done_nbt_session;
	
		/* only one negprot per connection is allowed */
		BOOL done_negprot;
	
		/* multiple session setups are allowed, but some parameters are
		   ignored in any but the first */
		BOOL done_sesssetup;
		
		/* 
		 * Size of data we can send to client. Set
		 *  by the client for all protocols above CORE.
		 *  Set by us for CORE protocol.
		 */
		unsigned max_send; /* init to BUFFER_SIZE */
	
		/*
		 * Size of the data we can receive. Set by us.
		 * Can be modified by the max xmit parameter.
		 */
		unsigned max_recv; /* init to BUFFER_SIZE */
	
		/* a guess at the remote architecture. Try not to rely on this - in almost
		   all cases using these values is the wrong thing to do */
		enum remote_arch_types ra_type;
	
		/* the negotiatiated protocol */
		enum protocol_types protocol;
	
		/* authentication context for multi-part negprot */
		struct auth_context *auth_context;
	
		/* state of NTLMSSP auth */
		struct auth_ntlmssp_state *ntlmssp_state;
	
		/* did we tell the client we support encrypted passwords? */
		BOOL encrypted_passwords;
	
		/* did we send an extended security negprot reply? */
		BOOL spnego_negotiated;
	
		/* client capabilities */
		uint32_t client_caps;
	
		/* the timezone we sent to the client */
		int zone_offset;
	} negotiate;

	/* the context associated with open tree connects on a smb socket */
	struct {
		/* list of open tree connects */
		struct smbsrv_tcon *tcons;

		/* an id tree used to allocate tids */
		struct idr_context *idtree_tid;
	} tree;

	/* the context associated with open files on an smb socket */
	struct {
		struct files_struct *files; /* open files */
		struct bitmap *file_bmap; /* bitmap used to allocate file handles */
	
		/* a fsp to use when chaining */
		struct files_struct *chain_fsp;
	
		/* a fsp to use to save when breaking an oplock. */
		struct files_struct *oplock_save_chain_fsp;
	
		/* how many files are open */
		int files_used;
	
		/* limit for maximum open files */
		int real_max_open_files;
	} file;

	/* context associated with currently valid session setups */
	struct {
		/* this holds info on session vuids that are already validated for this VC */
		struct smbsrv_session *session_list;
		uint16_t next_vuid; /* initialise to VUID_OFFSET */
		int num_validated_vuids;
	} sessions;

	/* this holds long term state specific to the printing subsystem */
	struct {
		struct notify_queue *notify_queue_head;
	} print;

	/* the server_context holds a linked list of pending requests,
	 * this is used for blocking locks and requests blocked due to oplock
	 * break requests */
	struct _smbsrv_pending_request {
		struct _smbsrv_pending_request *next, *prev;
	
		/* the request itself - needs to be freed */
		struct smbsrv_request *request;
	} *requests;

	/* the timers context contains info on when we last did various
	 * functions */
	struct {
		/* when did we last do timeout processing? */
		time_t last_timeout_processing;
	
		/* when did we last sent a keepalive */
		time_t last_keepalive_sent;
		
		/* when we last checked the smb.conf for auto-reload */
		time_t last_smb_conf_reload;
	} timers;

	struct smb_signing_context signing;

	struct substitute_context substitute;

	struct dcesrv_context *dcesrv;

	/* the pid of the process handling this session */
	pid_t pid;
	
	struct server_connection *connection;

	/* this holds a partially received request */
	struct smbsrv_request *partial_req;
};