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