d9f4727203cafd3e07329438b3e22b4fa519b142
[kai/samba.git] / source / 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         union {
53                 struct schannel_auth_struct *schannel_auth;
54                 NTLMSSP_STATE *ntlmssp_state;
55                 struct kerberos_auth_struct *kerberos_auth;
56         } a_u;
57         void (*cli_auth_data_free_func)(struct cli_pipe_auth_data *);
58 };
59
60 struct rpc_pipe_client {
61         struct rpc_pipe_client *prev, *next;
62
63         struct cli_state *cli;
64
65         const char *pipe_name;
66         uint16 fnum;
67
68         const struct ndr_syntax_id *abstract_syntax;
69         const struct ndr_syntax_id *transfer_syntax;
70
71         const char *desthost;
72         const char *srv_name_slash;
73
74         const char *domain;
75         const char *user_name;
76         struct pwd_info pwd;
77
78         uint16 max_xmit_frag;
79         uint16 max_recv_frag;
80
81         struct cli_pipe_auth_data auth;
82
83         /* The following is only non-null on a netlogon pipe. */
84         struct dcinfo *dc;
85 };
86
87 /* Transport encryption state. */
88 enum smb_trans_enc_type {
89                 SMB_TRANS_ENC_NTLM
90 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
91                 , SMB_TRANS_ENC_GSS
92 #endif
93 };
94
95 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
96 struct smb_tran_enc_state_gss {
97         gss_ctx_id_t gss_ctx;
98         gss_cred_id_t creds;
99 };
100 #endif
101
102 struct smb_trans_enc_state {
103         enum smb_trans_enc_type smb_enc_type;
104         uint16 enc_ctx_num;
105         bool enc_on;
106         union {
107                 NTLMSSP_STATE *ntlmssp_state;
108 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
109                 struct smb_tran_enc_state_gss *gss_state;
110 #endif
111         } s;
112 };
113
114 struct cli_state {
115         int port;
116         int fd;
117         /* Last read or write error. */
118         enum smb_read_errors smb_rw_error;
119         uint16 cnum;
120         uint16 pid;
121         uint16 mid;
122         uint16 vuid;
123         int protocol;
124         int sec_mode;
125         int rap_error;
126         int privileges;
127
128         fstring desthost;
129
130         /* The credentials used to open the cli_state connection. */
131         fstring domain;
132         fstring user_name;
133         struct pwd_info pwd;
134
135         /*
136          * The following strings are the
137          * ones returned by the server if
138          * the protocol > NT1.
139          */
140         fstring server_type;
141         fstring server_os;
142         fstring server_domain;
143
144         fstring share;
145         fstring dev;
146         struct nmb_name called;
147         struct nmb_name calling;
148         fstring full_dest_host_name;
149         struct sockaddr_storage dest_ss;
150
151         DATA_BLOB secblob; /* cryptkey or negTokenInit */
152         uint32 sesskey;
153         int serverzone;
154         uint32 servertime;
155         int readbraw_supported;
156         int writebraw_supported;
157         int timeout; /* in milliseconds. */
158         size_t max_xmit;
159         size_t max_mux;
160         char *outbuf;
161         char *inbuf;
162         unsigned int bufsize;
163         int initialised;
164         int win95;
165         bool is_samba;
166         uint32 capabilities;
167         uint32 posix_capabilities;
168         bool dfsroot;
169
170 #if 0
171         TALLOC_CTX *longterm_mem_ctx;
172         TALLOC_CTX *call_mem_ctx;
173 #endif
174
175         smb_sign_info sign_info;
176
177         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
178
179         /* the session key for this CLI, outside
180            any per-pipe authenticaion */
181         DATA_BLOB user_session_key;
182
183         /* The list of pipes currently open on this connection. */
184         struct rpc_pipe_client *pipe_list;
185
186         bool use_kerberos;
187         bool fallback_after_kerberos;
188         bool use_spnego;
189
190         bool use_oplocks; /* should we use oplocks? */
191         bool use_level_II_oplocks; /* should we use level II oplocks? */
192
193         /* a oplock break request handler */
194         bool (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
195
196         bool force_dos_errors;
197         bool case_sensitive; /* False by default. */
198
199         struct event_context *event_ctx;
200         struct fd_event *fd_event;
201         char *evt_inbuf;
202
203         struct cli_request *outstanding_requests;
204 };
205
206 struct cli_request {
207         struct cli_request *prev, *next;
208         struct async_req *async;
209
210         struct cli_state *cli;
211
212         struct smb_trans_enc_state *enc_state;
213
214         uint16_t mid;
215
216         char *outbuf;
217         size_t sent;
218         char *inbuf;
219
220         union {
221                 struct {
222                         off_t ofs;
223                         size_t size;
224                         ssize_t received;
225                         uint8_t *rcvbuf;
226                 } read;
227         } data;
228 };
229
230 typedef struct file_info {
231         struct cli_state *cli;
232         SMB_BIG_UINT size;
233         uint16 mode;
234         uid_t uid;
235         gid_t gid;
236         /* these times are normally kept in GMT */
237         struct timespec mtime_ts;
238         struct timespec atime_ts;
239         struct timespec ctime_ts;
240         char *name;
241         char short_name[13*3]; /* the *3 is to cope with multi-byte */
242 } file_info;
243
244 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
245 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
246 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
247 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
248
249 #endif /* _CLIENT_H */