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