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
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.
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.
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/>.
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. */
37 * These definitions depend on smb.h
40 struct print_job_info {
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 */
55 DATA_BLOB user_session_key;
58 struct schannel_auth_struct *schannel_auth;
59 NTLMSSP_STATE *ntlmssp_state;
60 struct kerberos_auth_struct *kerberos_auth;
65 * rpc_cli_transport defines a transport mechanism to ship rpc requests
66 * asynchronously to a server and receive replies
69 struct rpc_cli_transport {
72 * Trigger an async read from the server. May return a short read.
74 struct tevent_req *(*read_send)(TALLOC_CTX *mem_ctx,
75 struct event_context *ev,
76 uint8_t *data, size_t size,
79 * Get the result from the read_send operation.
81 NTSTATUS (*read_recv)(struct tevent_req *req, ssize_t *preceived);
84 * Trigger an async write to the server. May return a short write.
86 struct tevent_req *(*write_send)(TALLOC_CTX *mem_ctx,
87 struct event_context *ev,
88 const uint8_t *data, size_t size,
91 * Get the result from the read_send operation.
93 NTSTATUS (*write_recv)(struct tevent_req *req, ssize_t *psent);
96 * This is an optimization for the SMB transport. It models the
97 * TransactNamedPipe API call: Send and receive data in one round
98 * trip. The transport implementation is free to set this to NULL,
99 * cli_pipe.c will fall back to the explicit write/read routines.
101 struct tevent_req *(*trans_send)(TALLOC_CTX *mem_ctx,
102 struct event_context *ev,
103 uint8_t *data, size_t data_len,
104 uint32_t max_rdata_len,
107 * Get the result from the trans_send operation.
109 NTSTATUS (*trans_recv)(struct tevent_req *req, TALLOC_CTX *mem_ctx,
110 uint8_t **prdata, uint32_t *prdata_len);
114 struct rpc_pipe_client {
115 struct rpc_pipe_client *prev, *next;
117 struct rpc_cli_transport *transport;
119 struct ndr_syntax_id abstract_syntax;
120 struct ndr_syntax_id transfer_syntax;
122 NTSTATUS (*dispatch) (struct rpc_pipe_client *cli,
124 const struct ndr_interface_table *table,
125 uint32_t opnum, void *r);
128 char *srv_name_slash;
130 uint16 max_xmit_frag;
131 uint16 max_recv_frag;
133 struct cli_pipe_auth_data *auth;
135 /* The following is only non-null on a netlogon client pipe. */
136 struct netlogon_creds_CredentialState *dc;
138 /* Used by internal rpc_pipe_client */
139 pipes_struct *pipes_struct;
142 /* Transport encryption state. */
143 enum smb_trans_enc_type {
145 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
150 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
151 struct smb_tran_enc_state_gss {
152 gss_ctx_id_t gss_ctx;
157 struct smb_trans_enc_state {
158 enum smb_trans_enc_type smb_enc_type;
162 NTLMSSP_STATE *ntlmssp_state;
163 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
164 struct smb_tran_enc_state_gss *gss_state;
169 struct cli_state_seqnum {
170 struct cli_state_seqnum *prev, *next;
178 * A list of subsidiary connections for DFS.
180 struct cli_state *prev, *next;
183 /* Last read or write error. */
184 enum smb_read_errors smb_rw_error;
196 /* The credentials used to open the cli_state connection. */
199 char *password; /* Can be null to force use of zero NTLMSSP session key. */
202 * The following strings are the
203 * ones returned by the server if
204 * the protocol > NT1.
208 fstring server_domain;
212 struct nmb_name called;
213 struct nmb_name calling;
214 fstring full_dest_host_name;
215 struct sockaddr_storage dest_ss;
217 DATA_BLOB secblob; /* cryptkey or negTokenInit */
221 int readbraw_supported;
222 int writebraw_supported;
223 int timeout; /* in milliseconds. */
227 struct cli_state_seqnum *seqnum;
229 unsigned int bufsize;
234 uint32 posix_capabilities;
238 TALLOC_CTX *longterm_mem_ctx;
239 TALLOC_CTX *call_mem_ctx;
242 struct smb_signing_state *signing_state;
244 struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
246 /* the session key for this CLI, outside
247 any per-pipe authenticaion */
248 DATA_BLOB user_session_key;
250 /* The list of pipes currently open on this connection. */
251 struct rpc_pipe_client *pipe_list;
254 bool fallback_after_kerberos;
256 bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
258 bool use_oplocks; /* should we use oplocks? */
259 bool use_level_II_oplocks; /* should we use level II oplocks? */
261 /* a oplock break request handler */
262 NTSTATUS (*oplock_handler)(struct cli_state *cli, uint16_t fnum, unsigned char level);
264 bool force_dos_errors;
265 bool case_sensitive; /* False by default. */
267 /* Where (if anywhere) this is mounted under DFS. */
268 char *dfs_mountpoint;
270 struct tevent_queue *outgoing;
271 struct tevent_req **pending;
274 typedef struct file_info {
275 struct cli_state *cli;
280 /* these times are normally kept in GMT */
281 struct timespec mtime_ts;
282 struct timespec atime_ts;
283 struct timespec ctime_ts;
285 char short_name[13*3]; /* the *3 is to cope with multi-byte */
288 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
289 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
290 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
291 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
292 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
293 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
295 #endif /* _CLIENT_H */