r3315: converted the libcli/raw/ code to use the generic socket library. This
[jelmer/samba4-debian.git] / source / include / cli_context.h
1 /*
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup
4    Copyright (C) Andrew Tridgell 1992-1998
5    Copyright (C) Luke Kenneth Casson Leighton 1996-1998
6    Copyright (C) Jeremy Allison 1998
7    Copyright (C) James Myers 2003 <myersjj@samba.org>
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 #ifndef _SMBCLI_CONTEXT_H
25 #define _SMBCLI_CONTEXT_H
26
27 struct smbcli_tree;  /* forward declare */
28 struct smbcli_request;  /* forward declare */
29 struct smbcli_session;  /* forward declare */
30 struct smbcli_transport;  /* forward declare */
31
32 /* context that will be and has been negotiated between the client and server */
33 struct smbcli_negotiate {
34         /* 
35          * negotiated maximum transmit size - this is given to us by the server
36          */
37         uint32_t max_xmit;
38
39         /* maximum number of requests that can be multiplexed */
40         uint16_t max_mux;
41
42         /* the negotiatiated protocol */
43         enum protocol_types protocol;
44
45         uint8_t sec_mode;               /* security mode returned by negprot */
46         uint8_t key_len;
47         DATA_BLOB server_guid;      /* server_guid */
48         DATA_BLOB secblob;      /* cryptkey or negTokenInit blob */
49         uint32_t sesskey;
50         
51         struct smb_signing_context sign_info;
52
53         /* capabilities that the server reported */
54         uint32_t capabilities;
55         
56         int server_zone;
57         time_t server_time;
58         uint_t readbraw_supported:1;
59         uint_t writebraw_supported:1;
60
61         char *server_domain;
62 };
63         
64 /* this is the context for a SMB socket associated with the socket itself */
65 struct smbcli_socket {
66         struct in_addr dest_ip;
67         /* dest hostname (which may or may not be a DNS name) */
68         char *hostname;
69
70         /* the port used */
71         int port;
72         
73         struct socket_context *sock;
74
75         /* a count of the number of packets we have received. We
76          * actually only care about zero/non-zero at this stage */
77         uint_t pkt_count;
78
79         /* the network address of the client */
80         char *client_addr;
81         
82         /* timeout for socket operations in milliseconds. */
83         int timeout;
84 };
85
86 /*
87   this structure allows applications to control the behaviour of the
88   client library
89 */
90 struct smbcli_options {
91         uint_t use_oplocks:1;
92         uint_t use_level2_oplocks:1;
93         uint_t use_spnego:1;
94 };
95
96 /* this is the context for the client transport layer */
97 struct smbcli_transport {
98         /* socket level info */
99         struct smbcli_socket *socket;
100
101         /* the next mid to be allocated - needed for signing and
102            request matching */
103         uint16_t next_mid;
104         
105         /* negotiated protocol information */
106         struct smbcli_negotiate negotiate;
107
108         /* options to control the behaviour of the client code */
109         struct smbcli_options options;
110
111         /* is a readbraw pending? we need to handle that case
112            specially on receiving packets */
113         uint_t readbraw_pending:1;
114         
115         /* an idle function - if this is defined then it will be
116            called once every period seconds while we are waiting
117            for a packet */
118         struct {
119                 void (*func)(struct smbcli_transport *, void *);
120                 void *private;
121                 uint_t period;
122         } idle;
123
124         /* the error fields from the last message */
125         struct {
126                 enum {ETYPE_NONE, ETYPE_DOS, ETYPE_NT, ETYPE_SOCKET, ETYPE_NBT} etype;
127                 union {
128                         struct {
129                                 uint8_t eclass;
130                                 uint16_t ecode;
131                         } dos;
132                         NTSTATUS nt_status;
133                         enum {SOCKET_READ_TIMEOUT,
134                               SOCKET_READ_EOF,
135                               SOCKET_READ_ERROR,
136                               SOCKET_WRITE_ERROR,
137                               SOCKET_READ_BAD_SIG} socket_error;
138                         uint_t nbt_error;
139                 } e;
140         } error;
141
142         struct {
143                 /* a oplock break request handler */
144                 BOOL (*handler)(struct smbcli_transport *transport, 
145                                 uint16_t tid, uint16_t fnum, uint8_t level, void *private);
146                 /* private data passed to the oplock handler */
147                 void *private;
148         } oplock;
149
150         /* a list of async requests that are pending for send on this connection */
151         struct smbcli_request *pending_send;
152
153         /* a list of async requests that are pending for receive on this connection */
154         struct smbcli_request *pending_recv;
155
156         /* remember the called name - some sub-protocols require us to
157            know the server name */
158         struct nmb_name called;
159
160         /* a buffer for partially received SMB packets. */
161         struct {
162                 uint8_t header[NBT_HDR_SIZE];
163                 size_t req_size;
164                 size_t received;
165                 uint8_t *buffer;
166         } recv_buffer;
167
168         /* the event handle for waiting for socket IO */
169         struct {
170                 struct event_context *ctx;
171                 struct fd_event *fde;
172                 struct timed_event *te;
173         } event;
174 };
175
176 /* this is the context for the user */
177
178 /* this is the context for the session layer */
179 struct smbcli_session { 
180         /* transport layer info */
181         struct smbcli_transport *transport;
182         
183         /* after a session setup the server provides us with
184            a vuid identifying the security context */
185         uint16_t vuid;
186
187         /* default pid for this session */
188         uint32_t pid;
189
190         DATA_BLOB user_session_key;
191
192         /* the spnego context if we use extented security */
193         struct gensec_security *gensec;
194 };
195
196 /* 
197    smbcli_tree context: internal state for a tree connection. 
198  */
199 struct smbcli_tree {
200         /* session layer info */
201         struct smbcli_session *session;
202
203         uint16_t tid;                   /* tree id, aka cnum */
204         char *device;
205         char *fs_type;
206 };
207
208
209 /*
210   a client request moves between the following 4 states.
211 */
212 enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
213                         SMBCLI_REQUEST_SEND, /* the request is in the outgoing socket Q */
214                         SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
215                         SMBCLI_REQUEST_DONE, /* the request is finished */
216                         SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
217
218 /* the context for a single SMB request. This is passed to any request-context 
219  * functions (similar to context.h, the server version).
220  * This will allow requests to be multi-threaded. */
221 struct smbcli_request {
222         /* allow a request to be part of a list of requests */
223         struct smbcli_request *next, *prev;
224
225         /* each request is in one of 4 possible states */
226         enum smbcli_request_state state;
227         
228         /* a request always has a transport context, nearly always has
229            a session context and usually has a tree context */
230         struct smbcli_transport *transport;
231         struct smbcli_session *session;
232         struct smbcli_tree *tree;
233
234         /* the flags2 from the SMB request, in raw form (host byte
235            order). Used to parse strings */
236         uint16_t flags2;
237
238         /* the NT status for this request. Set by packet receive code
239            or code detecting error. */
240         NTSTATUS status;
241         
242         /* the sequence number of this packet - used for signing */
243         uint_t seq_num;
244
245         /* set if this is a one-way request, meaning we are not
246            expecting a reply from the server. */
247         uint_t one_way_request:1;
248
249         /* set this when the request should only increment the signing
250            counter by one */
251         uint_t sign_single_increment:1;
252
253         /* the mid of this packet - used to match replies */
254         uint16_t mid;
255
256         struct request_buffer in;
257         struct request_buffer out;
258
259         /* information on what to do with a reply when it is received
260            asyncronously. If this is not setup when a reply is received then
261            the reply is discarded
262
263            The private pointer is private to the caller of the client
264            library (the application), not private to the library
265         */
266         struct {
267                 void (*fn)(struct smbcli_request *);
268                 void *private;
269         } async;
270 };
271
272 /* 
273    smbcli_state: internal state used in libcli library for single-threaded callers, 
274    i.e. a single session on a single socket. 
275  */
276 struct smbcli_state {
277         struct smbcli_transport *transport;
278         struct smbcli_session *session;
279         struct smbcli_tree *tree;
280         struct substitute_context substitute;
281 };
282
283 /* useful way of catching wct errors with file and line number */
284 #define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
285       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
286       req->status = NT_STATUS_INVALID_PARAMETER; \
287       goto failed; \
288 }
289
290 #define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
291       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
292       req->status = NT_STATUS_INVALID_PARAMETER; \
293       goto failed; \
294 }
295
296 #endif /* _SMBCLI_CONTEXT_H */