Remove the static "struct client_connection" mess which is part of
[jra/samba/.git] / source3 / include / client.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
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 _CLIENT_H
23 #define _CLIENT_H
24
25 /* the client asks for a smaller buffer to save ram and also to get more
26    overlap on the wire. This size gives us a nice read/write size, which
27    will be a multiple of the page size on almost any system */
28 #define CLI_BUFFER_SIZE (0xFFFF)
29 #define CLI_SAMBA_MAX_LARGE_READX_SIZE (127*1024) /* Works for Samba servers */
30 #define CLI_SAMBA_MAX_LARGE_WRITEX_SIZE (127*1024) /* Works for Samba servers */
31 #define CLI_WINDOWS_MAX_LARGE_READX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
32 #define CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
33 #define CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
34 #define CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE (0xFFFF00) /* 24-bit len. */
35
36 /*
37  * These definitions depend on smb.h
38  */
39
40 struct print_job_info {
41         uint16 id;
42         uint16 priority;
43         size_t size;
44         fstring user;
45         fstring name;
46         time_t t;
47 };
48
49 struct cli_pipe_auth_data {
50         enum pipe_auth_type auth_type; /* switch for the union below. Defined in ntdomain.h */
51         enum pipe_auth_level auth_level; /* defined in ntdomain.h */
52
53         char *domain;
54         char *user_name;
55         DATA_BLOB user_session_key;
56
57         union {
58                 struct schannel_auth_struct *schannel_auth;
59                 NTLMSSP_STATE *ntlmssp_state;
60                 struct kerberos_auth_struct *kerberos_auth;
61         } a_u;
62 };
63
64 /**
65  * rpc_cli_transport defines a transport mechanism to ship rpc requests
66  * asynchronously to a server and receive replies
67  */
68
69 struct rpc_cli_transport {
70
71         /**
72          * Trigger an async read from the server. May return a short read.
73          */
74         struct async_req *(*read_send)(TALLOC_CTX *mem_ctx,
75                                        struct event_context *ev,
76                                        uint8_t *data, size_t size,
77                                        void *priv);
78         /**
79          * Get the result from the read_send operation.
80          */
81         NTSTATUS (*read_recv)(struct async_req *req, ssize_t *preceived);
82
83         /**
84          * Trigger an async write to the server. May return a short write.
85          */
86         struct async_req *(*write_send)(TALLOC_CTX *mem_ctx,
87                                         struct event_context *ev,
88                                         const uint8_t *data, size_t size,
89                                         void *priv);
90         /**
91          * Get the result from the read_send operation.
92          */
93         NTSTATUS (*write_recv)(struct async_req *req, ssize_t *psent);
94
95         /**
96          * This is an optimization for the SMB transport. It models the
97          * TransactNamedPipe API call: Send and receive data in one round
98          * trip. The transport implementation is free to set this to NULL,
99          * cli_pipe.c will fall back to the explicit write/read routines.
100          */
101         struct async_req *(*trans_send)(TALLOC_CTX *mem_ctx,
102                                         struct event_context *ev,
103                                         uint8_t *data, size_t data_len,
104                                         uint32_t max_rdata_len,
105                                         void *priv);
106         /**
107          * Get the result from the trans_send operation.
108          */
109         NTSTATUS (*trans_recv)(struct async_req *req, TALLOC_CTX *mem_ctx,
110                                uint8_t **prdata, uint32_t *prdata_len);
111         void *priv;
112 };
113
114 struct rpc_pipe_client {
115         struct rpc_pipe_client *prev, *next;
116
117         struct rpc_cli_transport *transport;
118
119         struct ndr_syntax_id abstract_syntax;
120         struct ndr_syntax_id transfer_syntax;
121
122         NTSTATUS (*dispatch) (struct rpc_pipe_client *cli,
123                         TALLOC_CTX *mem_ctx,
124                         const struct ndr_interface_table *table,
125                         uint32_t opnum, void *r);
126
127         char *desthost;
128         char *srv_name_slash;
129
130         uint16 max_xmit_frag;
131         uint16 max_recv_frag;
132
133         struct cli_pipe_auth_data *auth;
134
135         /* The following is only non-null on a netlogon pipe. */
136         struct dcinfo *dc;
137
138         /* Used by internal rpc_pipe_client */
139         pipes_struct *pipes_struct;
140 };
141
142 /* Transport encryption state. */
143 enum smb_trans_enc_type {
144                 SMB_TRANS_ENC_NTLM
145 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
146                 , SMB_TRANS_ENC_GSS
147 #endif
148 };
149
150 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
151 struct smb_tran_enc_state_gss {
152         gss_ctx_id_t gss_ctx;
153         gss_cred_id_t creds;
154 };
155 #endif
156
157 struct smb_trans_enc_state {
158         enum smb_trans_enc_type smb_enc_type;
159         uint16 enc_ctx_num;
160         bool enc_on;
161         union {
162                 NTLMSSP_STATE *ntlmssp_state;
163 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
164                 struct smb_tran_enc_state_gss *gss_state;
165 #endif
166         } s;
167 };
168
169 struct cli_state {
170         /**
171          * A list of subsidiary connections for DFS.
172          */
173         struct cli_state *prev, *next;
174         int port;
175         int fd;
176         /* Last read or write error. */
177         enum smb_read_errors smb_rw_error;
178         uint16 cnum;
179         uint16 pid;
180         uint16 mid;
181         uint16 vuid;
182         int protocol;
183         int sec_mode;
184         int rap_error;
185         int privileges;
186
187         fstring desthost;
188
189         /* The credentials used to open the cli_state connection. */
190         fstring domain;
191         fstring user_name;
192         struct pwd_info pwd;
193
194         /*
195          * The following strings are the
196          * ones returned by the server if
197          * the protocol > NT1.
198          */
199         fstring server_type;
200         fstring server_os;
201         fstring server_domain;
202
203         fstring share;
204         fstring dev;
205         struct nmb_name called;
206         struct nmb_name calling;
207         fstring full_dest_host_name;
208         struct sockaddr_storage dest_ss;
209
210         DATA_BLOB secblob; /* cryptkey or negTokenInit */
211         uint32 sesskey;
212         int serverzone;
213         uint32 servertime;
214         int readbraw_supported;
215         int writebraw_supported;
216         int timeout; /* in milliseconds. */
217         size_t max_xmit;
218         size_t max_mux;
219         char *outbuf;
220         char *inbuf;
221         unsigned int bufsize;
222         int initialised;
223         int win95;
224         bool is_samba;
225         uint32 capabilities;
226         uint32 posix_capabilities;
227         bool dfsroot;
228
229 #if 0
230         TALLOC_CTX *longterm_mem_ctx;
231         TALLOC_CTX *call_mem_ctx;
232 #endif
233
234         smb_sign_info sign_info;
235
236         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
237
238         /* the session key for this CLI, outside
239            any per-pipe authenticaion */
240         DATA_BLOB user_session_key;
241
242         /* The list of pipes currently open on this connection. */
243         struct rpc_pipe_client *pipe_list;
244
245         bool use_kerberos;
246         bool fallback_after_kerberos;
247         bool use_spnego;
248         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
249
250         bool use_oplocks; /* should we use oplocks? */
251         bool use_level_II_oplocks; /* should we use level II oplocks? */
252
253         /* a oplock break request handler */
254         bool (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
255
256         bool force_dos_errors;
257         bool case_sensitive; /* False by default. */
258
259         /**
260          * fd_event is around while we have async requests outstanding or are
261          * building a chained request.
262          *
263          * (fd_event!=NULL) &&
264          *  ((outstanding_request!=NULL)||(chain_accumulator!=NULL))
265          *
266          * should always be true, as well as the reverse: If both cli_request
267          * pointers are NULL, no fd_event is around.
268          */
269         struct fd_event *fd_event;
270         char *evt_inbuf;
271
272         /**
273          * A linked list of requests that are waiting for a reply
274          */
275         struct cli_request *outstanding_requests;
276
277         /**
278          * The place to build up the list of chained requests. In CIFS, a
279          * single cli_request corresponds to a MID and can serve more than one
280          * chained async_req.
281          */
282         struct cli_request *chain_accumulator;
283
284         /* Where (if anywhere) this is mounted under DFS. */
285         char *dfs_mountpoint;
286 };
287
288 typedef struct file_info {
289         struct cli_state *cli;
290         uint64_t size;
291         uint16 mode;
292         uid_t uid;
293         gid_t gid;
294         /* these times are normally kept in GMT */
295         struct timespec mtime_ts;
296         struct timespec atime_ts;
297         struct timespec ctime_ts;
298         char *name;
299         char short_name[13*3]; /* the *3 is to cope with multi-byte */
300 } file_info;
301
302 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
303 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
304 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
305 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
306
307 #endif /* _CLIENT_H */