[GLUE] Rsync SAMBA_3_2_0 SVN r25598 in order to create the v3-2-test branch.
[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_WINDOWS_MAX_LARGE_READX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
31 #define CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
32
33 /*
34  * These definitions depend on smb.h
35  */
36
37 struct print_job_info {
38         uint16 id;
39         uint16 priority;
40         size_t size;
41         fstring user;
42         fstring name;
43         time_t t;
44 };
45
46 struct cli_pipe_auth_data {
47         enum pipe_auth_type auth_type; /* switch for the union below. Defined in ntdomain.h */
48         enum pipe_auth_level auth_level; /* defined in ntdomain.h */
49         union {
50                 struct schannel_auth_struct *schannel_auth;
51                 NTLMSSP_STATE *ntlmssp_state;
52                 struct kerberos_auth_struct *kerberos_auth;
53         } a_u;
54         void (*cli_auth_data_free_func)(struct cli_pipe_auth_data *);
55 };
56
57 struct rpc_pipe_client {
58         struct rpc_pipe_client *prev, *next;
59
60         TALLOC_CTX *mem_ctx;
61
62         struct cli_state *cli;
63
64         int pipe_idx;
65         const char *pipe_name;
66         uint16 fnum;
67
68         const char *domain;
69         const char *user_name;
70         struct pwd_info pwd;
71
72         uint16 max_xmit_frag;
73         uint16 max_recv_frag;
74
75         struct cli_pipe_auth_data auth;
76
77         /* The following is only non-null on a netlogon pipe. */
78         struct dcinfo *dc;
79 };
80
81 struct cli_state {
82         int port;
83         int fd;
84         int smb_rw_error; /* Copy of last read or write error. */
85         uint16 cnum;
86         uint16 pid;
87         uint16 mid;
88         uint16 vuid;
89         int protocol;
90         int sec_mode;
91         int rap_error;
92         int privileges;
93
94         fstring desthost;
95
96         /* The credentials used to open the cli_state connection. */
97         fstring domain;
98         fstring user_name;
99         struct pwd_info pwd;
100
101         /*
102          * The following strings are the
103          * ones returned by the server if
104          * the protocol > NT1.
105          */
106         fstring server_type;
107         fstring server_os;
108         fstring server_domain;
109
110         fstring share;
111         fstring dev;
112         struct nmb_name called;
113         struct nmb_name calling;
114         fstring full_dest_host_name;
115         struct in_addr dest_ip;
116
117         DATA_BLOB secblob; /* cryptkey or negTokenInit */
118         uint32 sesskey;
119         int serverzone;
120         uint32 servertime;
121         int readbraw_supported;
122         int writebraw_supported;
123         int timeout; /* in milliseconds. */
124         size_t max_xmit;
125         size_t max_mux;
126         char *outbuf;
127         char *inbuf;
128         unsigned int bufsize;
129         int initialised;
130         int win95;
131         BOOL is_samba;
132         uint32 capabilities;
133         uint32 posix_capabilities;
134         BOOL dfsroot;
135
136         TALLOC_CTX *mem_ctx;
137
138         smb_sign_info sign_info;
139
140         /* the session key for this CLI, outside 
141            any per-pipe authenticaion */
142         DATA_BLOB user_session_key;
143
144         /* The list of pipes currently open on this connection. */
145         struct rpc_pipe_client *pipe_list;
146
147         BOOL use_kerberos;
148         BOOL fallback_after_kerberos;
149         BOOL use_spnego;
150
151         BOOL use_oplocks; /* should we use oplocks? */
152         BOOL use_level_II_oplocks; /* should we use level II oplocks? */
153
154         /* a oplock break request handler */
155         BOOL (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
156
157         BOOL force_dos_errors;
158         BOOL case_sensitive; /* False by default. */
159 };
160
161 typedef struct file_info {
162         struct cli_state *cli;
163         SMB_BIG_UINT size;
164         uint16 mode;
165         uid_t uid;
166         gid_t gid;
167         /* these times are normally kept in GMT */
168         struct timespec mtime_ts;
169         struct timespec atime_ts;
170         struct timespec ctime_ts;
171         pstring name;
172         pstring dir;
173         char short_name[13*3]; /* the *3 is to cope with multi-byte */
174 } file_info;
175
176 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
177 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
178 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
179
180 #endif /* _CLIENT_H */