s3-rpc_client: add and use rpc_client/rpc_client.h.
[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 #include "../librpc/ndr/libndr.h"
26
27 /* the client asks for a smaller buffer to save ram and also to get more
28    overlap on the wire. This size gives us a nice read/write size, which
29    will be a multiple of the page size on almost any system */
30 #define CLI_BUFFER_SIZE (0xFFFF)
31 #define CLI_SAMBA_MAX_LARGE_READX_SIZE (127*1024) /* Works for Samba servers */
32 #define CLI_SAMBA_MAX_LARGE_WRITEX_SIZE (127*1024) /* Works for Samba servers */
33 #define CLI_WINDOWS_MAX_LARGE_READX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
34 #define CLI_WINDOWS_MAX_LARGE_WRITEX_SIZE ((64*1024)-2) /* Windows servers are broken.... */
35 #define CLI_SAMBA_MAX_POSIX_LARGE_READX_SIZE (0xFFFF00) /* 24-bit len. */
36 #define CLI_SAMBA_MAX_POSIX_LARGE_WRITEX_SIZE (0xFFFF00) /* 24-bit len. */
37
38 /*
39  * These definitions depend on smb.h
40  */
41
42 struct print_job_info {
43         uint16 id;
44         uint16 priority;
45         size_t size;
46         fstring user;
47         fstring name;
48         time_t t;
49 };
50
51 struct cli_state_seqnum {
52         struct cli_state_seqnum *prev, *next;
53         uint16_t mid;
54         uint32_t seqnum;
55         bool persistent;
56 };
57
58 struct cli_state {
59         /**
60          * A list of subsidiary connections for DFS.
61          */
62         struct cli_state *prev, *next;
63         int port;
64         int fd;
65         /* Last read or write error. */
66         enum smb_read_errors smb_rw_error;
67         uint16 cnum;
68         uint16 pid;
69         uint16 mid;
70         uint16 vuid;
71         int protocol;
72         int sec_mode;
73         int rap_error;
74         int privileges;
75
76         fstring desthost;
77
78         /* The credentials used to open the cli_state connection. */
79         char *domain;
80         char *user_name;
81         char *password; /* Can be null to force use of zero NTLMSSP session key. */
82
83         /*
84          * The following strings are the
85          * ones returned by the server if
86          * the protocol > NT1.
87          */
88         fstring server_type;
89         fstring server_os;
90         fstring server_domain;
91
92         fstring share;
93         fstring dev;
94         struct nmb_name called;
95         struct nmb_name calling;
96         struct sockaddr_storage dest_ss;
97
98         DATA_BLOB secblob; /* cryptkey or negTokenInit */
99         uint32 sesskey;
100         int serverzone;
101         uint32 servertime;
102         int readbraw_supported;
103         int writebraw_supported;
104         int timeout; /* in milliseconds. */
105         size_t max_xmit;
106         size_t max_mux;
107         char *outbuf;
108         struct cli_state_seqnum *seqnum;
109         char *inbuf;
110         unsigned int bufsize;
111         int initialised;
112         int win95;
113         bool is_samba;
114         uint32 capabilities;
115         /* What the server offered. */
116         uint32_t server_posix_capabilities;
117         /* What the client requested. */
118         uint32_t requested_posix_capabilities;
119         bool dfsroot;
120
121         struct smb_signing_state *signing_state;
122
123         struct smb_trans_enc_state *trans_enc_state; /* Setup if we're encrypting SMB's. */
124
125         /* the session key for this CLI, outside
126            any per-pipe authenticaion */
127         DATA_BLOB user_session_key;
128
129         /* The list of pipes currently open on this connection. */
130         struct rpc_pipe_client *pipe_list;
131
132         bool use_kerberos;
133         bool fallback_after_kerberos;
134         bool use_spnego;
135         bool use_ccache;
136         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
137
138         bool use_oplocks; /* should we use oplocks? */
139         bool use_level_II_oplocks; /* should we use level II oplocks? */
140
141         /* a oplock break request handler */
142         NTSTATUS (*oplock_handler)(struct cli_state *cli, uint16_t fnum, unsigned char level);
143
144         bool force_dos_errors;
145         bool case_sensitive; /* False by default. */
146
147         /* Where (if anywhere) this is mounted under DFS. */
148         char *dfs_mountpoint;
149
150         struct tevent_queue *outgoing;
151         struct tevent_req **pending;
152 };
153
154 struct file_info {
155         uint64_t size;
156         uint16 mode;
157         uid_t uid;
158         gid_t gid;
159         /* these times are normally kept in GMT */
160         struct timespec mtime_ts;
161         struct timespec atime_ts;
162         struct timespec ctime_ts;
163         char *name;
164         char short_name[13*3]; /* the *3 is to cope with multi-byte */
165 };
166
167 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
168 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
169 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
170 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
171 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
172 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
173 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
174
175 #endif /* _CLIENT_H */