s3: Add ccache use to cli_session_setup_ntlmssp
[nivanova/samba-autobuild/.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 dcerpc_AuthLevel 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_state *schannel_auth;
59                 struct 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         enum dcerpc_transport_t transport;
72
73         /**
74          * Trigger an async read from the server. May return a short read.
75          */
76         struct tevent_req *(*read_send)(TALLOC_CTX *mem_ctx,
77                                         struct event_context *ev,
78                                         uint8_t *data, size_t size,
79                                         void *priv);
80         /**
81          * Get the result from the read_send operation.
82          */
83         NTSTATUS (*read_recv)(struct tevent_req *req, ssize_t *preceived);
84
85         /**
86          * Trigger an async write to the server. May return a short write.
87          */
88         struct tevent_req *(*write_send)(TALLOC_CTX *mem_ctx,
89                                          struct event_context *ev,
90                                          const uint8_t *data, size_t size,
91                                          void *priv);
92         /**
93          * Get the result from the read_send operation.
94          */
95         NTSTATUS (*write_recv)(struct tevent_req *req, ssize_t *psent);
96
97         /**
98          * This is an optimization for the SMB transport. It models the
99          * TransactNamedPipe API call: Send and receive data in one round
100          * trip. The transport implementation is free to set this to NULL,
101          * cli_pipe.c will fall back to the explicit write/read routines.
102          */
103         struct tevent_req *(*trans_send)(TALLOC_CTX *mem_ctx,
104                                          struct event_context *ev,
105                                          uint8_t *data, size_t data_len,
106                                          uint32_t max_rdata_len,
107                                          void *priv);
108         /**
109          * Get the result from the trans_send operation.
110          */
111         NTSTATUS (*trans_recv)(struct tevent_req *req, TALLOC_CTX *mem_ctx,
112                                uint8_t **prdata, uint32_t *prdata_len);
113         void *priv;
114 };
115
116 struct rpc_pipe_client {
117         struct rpc_pipe_client *prev, *next;
118
119         struct rpc_cli_transport *transport;
120
121         struct ndr_syntax_id abstract_syntax;
122         struct ndr_syntax_id transfer_syntax;
123
124         NTSTATUS (*dispatch) (struct rpc_pipe_client *cli,
125                         TALLOC_CTX *mem_ctx,
126                         const struct ndr_interface_table *table,
127                         uint32_t opnum, void *r);
128
129         struct tevent_req *(*dispatch_send)(
130                 TALLOC_CTX *mem_ctx,
131                 struct tevent_context *ev,
132                 struct rpc_pipe_client *cli,
133                 const struct ndr_interface_table *table,
134                 uint32_t opnum,
135                 void *r);
136         NTSTATUS (*dispatch_recv)(struct tevent_req *req,
137                                   TALLOC_CTX *mem_ctx);
138
139
140         char *desthost;
141         char *srv_name_slash;
142
143         uint16 max_xmit_frag;
144         uint16 max_recv_frag;
145
146         struct cli_pipe_auth_data *auth;
147
148         /* The following is only non-null on a netlogon client pipe. */
149         struct netlogon_creds_CredentialState *dc;
150
151         /* Used by internal rpc_pipe_client */
152         pipes_struct *pipes_struct;
153 };
154
155 /* Transport encryption state. */
156 enum smb_trans_enc_type {
157                 SMB_TRANS_ENC_NTLM
158 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
159                 , SMB_TRANS_ENC_GSS
160 #endif
161 };
162
163 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
164 struct smb_tran_enc_state_gss {
165         gss_ctx_id_t gss_ctx;
166         gss_cred_id_t creds;
167 };
168 #endif
169
170 struct smb_trans_enc_state {
171         enum smb_trans_enc_type smb_enc_type;
172         uint16 enc_ctx_num;
173         bool enc_on;
174         union {
175                 struct ntlmssp_state *ntlmssp_state;
176 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
177                 struct smb_tran_enc_state_gss *gss_state;
178 #endif
179         } s;
180 };
181
182 struct cli_state_seqnum {
183         struct cli_state_seqnum *prev, *next;
184         uint16_t mid;
185         uint32_t seqnum;
186         bool persistent;
187 };
188
189 struct cli_state {
190         /**
191          * A list of subsidiary connections for DFS.
192          */
193         struct cli_state *prev, *next;
194         int port;
195         int fd;
196         /* Last read or write error. */
197         enum smb_read_errors smb_rw_error;
198         uint16 cnum;
199         uint16 pid;
200         uint16 mid;
201         uint16 vuid;
202         int protocol;
203         int sec_mode;
204         int rap_error;
205         int privileges;
206
207         fstring desthost;
208
209         /* The credentials used to open the cli_state connection. */
210         char *domain;
211         char *user_name;
212         char *password; /* Can be null to force use of zero NTLMSSP session key. */
213
214         /*
215          * The following strings are the
216          * ones returned by the server if
217          * the protocol > NT1.
218          */
219         fstring server_type;
220         fstring server_os;
221         fstring server_domain;
222
223         fstring share;
224         fstring dev;
225         struct nmb_name called;
226         struct nmb_name calling;
227         fstring full_dest_host_name;
228         struct sockaddr_storage dest_ss;
229
230         DATA_BLOB secblob; /* cryptkey or negTokenInit */
231         uint32 sesskey;
232         int serverzone;
233         uint32 servertime;
234         int readbraw_supported;
235         int writebraw_supported;
236         int timeout; /* in milliseconds. */
237         size_t max_xmit;
238         size_t max_mux;
239         char *outbuf;
240         struct cli_state_seqnum *seqnum;
241         char *inbuf;
242         unsigned int bufsize;
243         int initialised;
244         int win95;
245         bool is_samba;
246         uint32 capabilities;
247         uint32 posix_capabilities;
248         bool dfsroot;
249
250 #if 0
251         TALLOC_CTX *longterm_mem_ctx;
252         TALLOC_CTX *call_mem_ctx;
253 #endif
254
255         struct smb_signing_state *signing_state;
256
257         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
258
259         /* the session key for this CLI, outside
260            any per-pipe authenticaion */
261         DATA_BLOB user_session_key;
262
263         /* The list of pipes currently open on this connection. */
264         struct rpc_pipe_client *pipe_list;
265
266         bool use_kerberos;
267         bool fallback_after_kerberos;
268         bool use_spnego;
269         bool use_ccache;
270         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
271
272         bool use_oplocks; /* should we use oplocks? */
273         bool use_level_II_oplocks; /* should we use level II oplocks? */
274
275         /* a oplock break request handler */
276         NTSTATUS (*oplock_handler)(struct cli_state *cli, uint16_t fnum, unsigned char level);
277
278         bool force_dos_errors;
279         bool case_sensitive; /* False by default. */
280
281         /* Where (if anywhere) this is mounted under DFS. */
282         char *dfs_mountpoint;
283
284         struct tevent_queue *outgoing;
285         struct tevent_req **pending;
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 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
307 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
308
309 #endif /* _CLIENT_H */