95e69431c1ef99743b8212781c75dc340e941b78
[samba.git] / source4 / 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 3 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, see <http://www.gnu.org/licenses/>.
20 */
21
22 #ifndef __LIBCLI_RAW_H__
23 #define __LIBCLI_RAW_H__
24
25 #include "../libcli/smb/smb_common.h"
26 #include "libcli/raw/request.h"
27 #include "librpc/gen_ndr/nbt.h"
28 #include "libcli/raw/interfaces.h"
29
30 struct smbcli_tree;  /* forward declare */
31 struct smbcli_request;  /* forward declare */
32 struct smbcli_session;  /* forward declare */
33 struct smbcli_transport;  /* forward declare */
34
35 struct resolve_context;
36 struct cli_credentials;
37 struct gensec_settings;
38
39 /* default timeout for all smb requests */
40 #define SMB_REQUEST_TIMEOUT 60
41
42 /* context that will be and has been negotiated between the client and server */
43 struct smbcli_negotiate {
44         /* 
45          * negotiated maximum transmit size - this is given to us by the server
46          */
47         uint32_t max_xmit;
48
49         /* maximum number of requests that can be multiplexed */
50         uint16_t max_mux;
51
52         /* the negotiatiated protocol */
53         enum protocol_types protocol;
54
55         uint8_t sec_mode;               /* security mode returned by negprot */
56         DATA_BLOB secblob;      /* cryptkey or negTokenInit blob */
57         uint32_t sesskey;
58
59         /* capabilities that the server reported */
60         uint32_t capabilities;
61         
62         int server_zone;
63         time_t server_time;
64
65         unsigned int readbraw_supported:1;
66         unsigned int writebraw_supported:1;
67         unsigned int lockread_supported:1;
68 };
69         
70 /* this is the context for a SMB socket associated with the socket itself */
71 struct smbcli_socket {
72         struct socket_context *sock;
73
74         /* what port we ended up connected to */
75         int port;
76
77         /* the hostname we connected to */
78         const char *hostname;
79
80         /* the event handle for waiting for socket IO */
81         struct {
82                 struct tevent_context *ctx;
83                 struct tevent_fd *fde;
84                 struct tevent_timer *te;
85         } event;
86 };
87
88 /*
89   this structure allows applications to control the behaviour of the
90   client library
91 */
92 struct smbcli_options {
93         unsigned int use_oplocks:1;
94         unsigned int use_level2_oplocks:1;
95         unsigned int use_spnego:1;
96         unsigned int unicode:1;
97         unsigned int ntstatus_support:1;
98         int max_protocol;
99         uint32_t max_xmit;
100         uint16_t max_mux;
101         int request_timeout;
102         enum smb_signing_setting signing;
103         uint32_t smb2_capabilities;
104         struct GUID client_guid;
105 };
106
107 /* this is the context for the client transport layer */
108 struct smbcli_transport {
109         struct tevent_context *ev; /* TODO: remove this !!! */
110         struct smbXcli_conn *conn;
111
112         /* negotiated protocol information */
113         struct smbcli_negotiate negotiate;
114
115         /* options to control the behaviour of the client code */
116         struct smbcli_options options;
117
118         /* an idle function - if this is defined then it will be
119            called once every period microseconds while we are waiting
120            for a packet */
121         struct {
122                 void (*func)(struct smbcli_transport *, void *);
123                 void *private_data;
124                 unsigned int period;
125                 struct tevent_timer *te;
126         } idle;
127
128         /* the error fields from the last message */
129         struct {
130                 enum {ETYPE_NONE, ETYPE_SMB, ETYPE_SOCKET, ETYPE_NBT} etype;
131                 union {
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                         unsigned int 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_data);
146                 /* private data passed to the oplock handler */
147                 void *private_data;
148         } oplock;
149         struct tevent_req *break_subreq;
150 };
151
152 /* this is the context for the user */
153
154 /* this is the context for the session layer */
155 struct smbcli_session { 
156         /* transport layer info */
157         struct smbcli_transport *transport;
158         
159         /* after a session setup the server provides us with
160            a vuid identifying the security context */
161         struct smbXcli_session *smbXcli;
162         uint16_t vuid;
163
164         /* default pid for this session */
165         uint32_t pid;
166
167         /* the flags2 for each packet - this allows
168            the user to control these for torture testing */
169         uint16_t flags2;
170
171         /* the spnego context if we use extented security */
172         struct gensec_security *gensec;
173
174         struct smbcli_session_options {
175                 unsigned int lanman_auth:1;
176                 unsigned int ntlmv2_auth:1;
177                 unsigned int plaintext_auth:1;
178         } options;
179
180         const char *os;
181         const char *lanman;
182 };
183
184 /* 
185    smbcli_tree context: internal state for a tree connection. 
186  */
187 struct smbcli_tree {
188         /* session layer info */
189         struct smbcli_session *session;
190
191         struct smbXcli_tcon *smbXcli;
192         uint16_t tid;                   /* tree id, aka cnum */
193         char *device;
194         char *fs_type;
195 };
196
197
198 /*
199   a client request moves between the following 4 states.
200 */
201 enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
202                         SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
203                         SMBCLI_REQUEST_DONE, /* the request is finished */
204                         SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
205
206 /* the context for a single SMB request. This is passed to any request-context 
207  * functions (similar to context.h, the server version).
208  * This will allow requests to be multi-threaded. */
209 struct smbcli_request {
210         /* smbXcli_req */
211         struct tevent_req *subreqs[2];
212
213         /* each request is in one of 4 possible states */
214         enum smbcli_request_state state;
215         
216         /* a request always has a transport context, nearly always has
217            a session context and usually has a tree context */
218         struct smbcli_transport *transport;
219         struct smbcli_session *session;
220         struct smbcli_tree *tree;
221
222         /* the flags2 from the SMB request, in raw form (host byte
223            order). Used to parse strings */
224         uint16_t flags2;
225
226         /* the NT status for this request. Set by packet receive code
227            or code detecting error. */
228         NTSTATUS status;
229
230         /* the caller wants to do the signing check */
231         bool sign_caller_checks;
232
233         /* give the caller a chance to prevent the talloc_free() in the _recv() function */
234         bool do_not_free;
235
236         struct smb_request_buffer in;
237         struct smb_request_buffer out;
238
239         struct smb_trans2 trans2;
240         struct smb_nttrans nttrans;
241
242         /* information on what to do with a reply when it is received
243            asyncronously. If this is not setup when a reply is received then
244            the reply is discarded
245
246            The private pointer is private to the caller of the client
247            library (the application), not private to the library
248         */
249         struct {
250                 void (*fn)(struct smbcli_request *);
251                 void *private_data;
252         } async;
253 };
254
255 /* useful way of catching wct errors with file and line number */
256 #define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
257       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
258       req->status = NT_STATUS_INVALID_PARAMETER; \
259       goto failed; \
260 }
261
262 #define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
263       DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
264       req->status = NT_STATUS_INVALID_PARAMETER; \
265       goto failed; \
266 }
267
268 NTSTATUS smb_raw_read_recv(struct smbcli_request *req, union smb_read *parms);
269 struct smbcli_request *smb_raw_read_send(struct smbcli_tree *tree, union smb_read *parms);
270 NTSTATUS smb_raw_trans_recv(struct smbcli_request *req,
271                              TALLOC_CTX *mem_ctx,
272                              struct smb_trans2 *parms);
273 size_t smb_raw_max_trans_data(struct smbcli_tree *tree, size_t param_size);
274 struct smbcli_request *smb_raw_trans_send(struct smbcli_tree *tree, struct smb_trans2 *parms);
275 NTSTATUS smbcli_request_destroy(struct smbcli_request *req);
276 struct smbcli_request *smb_raw_write_send(struct smbcli_tree *tree, union smb_write *parms);
277 NTSTATUS smb_raw_write_recv(struct smbcli_request *req, union smb_write *parms);
278 struct smbcli_request *smb_raw_close_send(struct smbcli_tree *tree, union smb_close *parms);
279 NTSTATUS smb_raw_open_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx, union smb_open *parms);
280 struct smbcli_request *smb_raw_open_send(struct smbcli_tree *tree, union smb_open *parms);
281
282 bool smbcli_transport_process(struct smbcli_transport *transport);
283 const char *smbcli_errstr(struct smbcli_tree *tree);
284 NTSTATUS smb_raw_fsinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fsinfo *fsinfo);
285 NTSTATUS smb_raw_setfsinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_setfsinfo *set_fsinfo);
286 NTSTATUS smb_raw_pathinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fileinfo *parms);
287 NTSTATUS smb_raw_shadow_data(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, struct smb_shadow_copy *info);
288 NTSTATUS smb_raw_fileinfo(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_fileinfo *parms);
289 struct smbcli_tree *smbcli_tree_init(struct smbcli_session *session, TALLOC_CTX *parent_ctx, bool primary);
290 NTSTATUS smb_raw_tcon(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_tcon *parms);
291 void smbcli_oplock_handler(struct smbcli_transport *transport, 
292                         bool (*handler)(struct smbcli_transport *, uint16_t, uint16_t, uint8_t, void *),
293                         void *private_data);
294 void smbcli_transport_idle_handler(struct smbcli_transport *transport, 
295                                    void (*idle_func)(struct smbcli_transport *, void *),
296                                    uint64_t period,
297                                    void *private_data);
298 NTSTATUS smbcli_request_simple_recv(struct smbcli_request *req);
299 bool smbcli_oplock_ack(struct smbcli_tree *tree, uint16_t fnum, uint16_t ack_level);
300 NTSTATUS smb_raw_open(struct smbcli_tree *tree, TALLOC_CTX *mem_ctx, union smb_open *parms);
301 NTSTATUS smb_raw_close(struct smbcli_tree *tree, union smb_close *parms);
302 NTSTATUS smb_raw_unlink(struct smbcli_tree *tree, union smb_unlink *parms);
303 NTSTATUS smb_raw_chkpath(struct smbcli_tree *tree, union smb_chkpath *parms);
304 NTSTATUS smb_raw_mkdir(struct smbcli_tree *tree, union smb_mkdir *parms);
305 NTSTATUS smb_raw_rmdir(struct smbcli_tree *tree, struct smb_rmdir *parms);
306 NTSTATUS smb_raw_rename(struct smbcli_tree *tree, union smb_rename *parms);
307 NTSTATUS smb_raw_seek(struct smbcli_tree *tree, union smb_seek *parms);
308 NTSTATUS smb_raw_read(struct smbcli_tree *tree, union smb_read *parms);
309 NTSTATUS smb_raw_write(struct smbcli_tree *tree, union smb_write *parms);
310 NTSTATUS smb_raw_lock(struct smbcli_tree *tree, union smb_lock *parms);
311 NTSTATUS smb_raw_setpathinfo(struct smbcli_tree *tree, union smb_setfileinfo *parms);
312 NTSTATUS smb_raw_setfileinfo(struct smbcli_tree *tree, union smb_setfileinfo *parms);
313
314 struct smbcli_request *smb_raw_changenotify_send(struct smbcli_tree *tree, union smb_notify *parms);
315 NTSTATUS smb_raw_changenotify_recv(struct smbcli_request *req, TALLOC_CTX *mem_ctx, union smb_notify *parms);
316
317 NTSTATUS smb_tree_disconnect(struct smbcli_tree *tree);
318 NTSTATUS smbcli_nt_error(struct smbcli_tree *tree);
319 NTSTATUS smb_raw_exit(struct smbcli_session *session);
320 NTSTATUS smb_raw_pathinfo_recv(struct smbcli_request *req,
321                                TALLOC_CTX *mem_ctx,
322                                union smb_fileinfo *parms);
323 struct smbcli_request *smb_raw_pathinfo_send(struct smbcli_tree *tree,
324                                              union smb_fileinfo *parms);
325 struct smbcli_request *smb_raw_setpathinfo_send(struct smbcli_tree *tree,
326                                              union smb_setfileinfo *parms);
327 struct smbcli_request *smb_raw_echo_send(struct smbcli_transport *transport,
328                                          struct smb_echo *p);
329 NTSTATUS smb_raw_search_first(struct smbcli_tree *tree,
330                               TALLOC_CTX *mem_ctx,
331                               union smb_search_first *io, void *private_data,
332                               smbcli_search_callback callback);
333 NTSTATUS smb_raw_flush(struct smbcli_tree *tree, union smb_flush *parms);
334
335 NTSTATUS smb_raw_trans(struct smbcli_tree *tree,
336                        TALLOC_CTX *mem_ctx,
337                        struct smb_trans2 *parms);
338
339 #endif /* __LIBCLI_RAW__H__ */