s3:libsmb: remove unused enum smb_read_errors infrastructure
[idra/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_state {
50         /**
51          * A list of subsidiary connections for DFS.
52          */
53         struct cli_state *prev, *next;
54         int port;
55         int fd;
56         uint16 cnum;
57         uint16 pid;
58         uint16 mid;
59         uint16 vuid;
60         int protocol;
61         int sec_mode;
62         int rap_error;
63         int privileges;
64
65         char *desthost;
66
67         /* The credentials used to open the cli_state connection. */
68         char *domain;
69         char *user_name;
70         char *password; /* Can be null to force use of zero NTLMSSP session key. */
71
72         /*
73          * The following strings are the
74          * ones returned by the server if
75          * the protocol > NT1.
76          */
77         char *server_type;
78         char *server_os;
79         char *server_domain;
80
81         char *share;
82         char *dev;
83         struct nmb_name called;
84         struct nmb_name calling;
85         struct sockaddr_storage dest_ss;
86
87         DATA_BLOB secblob; /* cryptkey or negTokenInit */
88         uint32 sesskey;
89         int serverzone;
90         uint32 servertime;
91         int readbraw_supported;
92         int writebraw_supported;
93         int timeout; /* in milliseconds. */
94         size_t max_xmit;
95         size_t max_mux;
96         char *inbuf;
97         unsigned int bufsize;
98         int initialised;
99         int win95;
100         bool is_samba;
101         bool is_guestlogin;
102         uint32 capabilities;
103         /* What the server offered. */
104         uint32_t server_posix_capabilities;
105         /* What the client requested. */
106         uint32_t requested_posix_capabilities;
107         bool dfsroot;
108
109         struct smb_signing_state *signing_state;
110
111         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
112
113         /* the session key for this CLI, outside
114            any per-pipe authenticaion */
115         DATA_BLOB user_session_key;
116
117         /* The list of pipes currently open on this connection. */
118         struct rpc_pipe_client *pipe_list;
119
120         bool use_kerberos;
121         bool fallback_after_kerberos;
122         bool use_spnego;
123         bool use_ccache;
124         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
125
126         bool use_oplocks; /* should we use oplocks? */
127         bool use_level_II_oplocks; /* should we use level II oplocks? */
128
129         /* a oplock break request handler */
130         NTSTATUS (*oplock_handler)(struct cli_state *cli, uint16_t fnum, unsigned char level);
131
132         bool force_dos_errors;
133         bool case_sensitive; /* False by default. */
134
135         /* Where (if anywhere) this is mounted under DFS. */
136         char *dfs_mountpoint;
137
138         struct tevent_queue *outgoing;
139         struct tevent_req **pending;
140
141         struct {
142                 uint64_t mid;
143                 uint32_t pid;
144                 uint32_t tid;
145                 uint64_t uid;
146
147                 /* SMB2 negprot */
148                 uint16_t security_mode;
149                 uint16_t dialect_revision;
150                 struct GUID server_guid;
151                 uint16_t server_capabilities;
152                 uint32_t max_transact_size;
153                 uint32_t max_read_size;
154                 uint32_t max_write_size;
155                 struct timespec system_time;
156                 struct timespec server_start_time;
157
158                 /* SMB2 tcon */
159                 uint8_t share_type;
160                 uint32_t share_flags;
161                 uint32_t maximal_access;
162         } smb2;
163 };
164
165 struct file_info {
166         uint64_t size;
167         uint16 mode;
168         uid_t uid;
169         gid_t gid;
170         /* these times are normally kept in GMT */
171         struct timespec mtime_ts;
172         struct timespec atime_ts;
173         struct timespec ctime_ts;
174         char *name;
175         char *short_name;
176 };
177
178 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
179 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
180 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
181 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
182 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
183 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
184 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
185
186 #endif /* _CLIENT_H */