babcfb8a660f293326443236f6347ff7b30bc39c
[mat/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 #define CLI_BUFFER_SIZE (0xFFFF)
26
27 /* default client timeout to 20 seconds on most commands */
28 #define CLIENT_TIMEOUT (20 * 1000)
29
30 /*
31  * These definitions depend on smb.h
32  */
33
34 struct print_job_info {
35         uint16 id;
36         uint16 priority;
37         size_t size;
38         fstring user;
39         fstring name;
40         time_t t;
41 };
42
43 struct smbXcli_conn;
44 struct smbXcli_session;
45
46 struct cli_state {
47         /**
48          * A list of subsidiary connections for DFS.
49          */
50         struct cli_state *prev, *next;
51         int rap_error;
52         NTSTATUS raw_status; /* maybe via NT_STATUS_DOS() */
53         bool map_dos_errors;
54
55         /* The credentials used to open the cli_state connection. */
56         char *domain;
57         char *user_name;
58         char *password; /* Can be null to force use of zero NTLMSSP session key. */
59
60         /*
61          * The following strings are the
62          * ones returned by the server if
63          * the protocol > NT1.
64          */
65         char *server_type;
66         char *server_os;
67         char *server_domain;
68
69         char *share;
70         char *dev;
71
72         int timeout; /* in milliseconds. */
73         int initialised;
74         int win95;
75         /* What the server offered. */
76         uint32_t server_posix_capabilities;
77         /* What the client requested. */
78         uint32_t requested_posix_capabilities;
79         bool backup_intent;
80
81         /* The list of pipes currently open on this connection. */
82         struct rpc_pipe_client *pipe_list;
83
84         bool use_kerberos;
85         bool fallback_after_kerberos;
86         bool use_ccache;
87         bool pw_nt_hash;
88         bool got_kerberos_mechanism; /* Server supports krb5 in SPNEGO. */
89
90         bool use_oplocks; /* should we use oplocks? */
91
92         bool case_sensitive; /* False by default. */
93
94         /* Where (if anywhere) this is mounted under DFS. */
95         char *dfs_mountpoint;
96
97         struct smbXcli_conn *conn;
98         const char *remote_realm;
99
100         struct {
101                 uint16_t pid;
102                 uint16_t vc_num;
103                 struct smbXcli_session *session;
104                 struct smbXcli_tcon *tcon;
105         } smb1;
106
107         struct {
108                 struct smbXcli_session *session;
109                 struct smbXcli_tcon *tcon;
110                 struct idr_context *open_handles;
111         } smb2;
112 };
113
114 struct file_info {
115         uint64_t size;
116         uint16 mode;
117         uid_t uid;
118         gid_t gid;
119         /* these times are normally kept in GMT */
120         struct timespec mtime_ts;
121         struct timespec atime_ts;
122         struct timespec ctime_ts;
123         char *name;
124         char *short_name;
125 };
126
127 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
128 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
129 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
130 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
131 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
132 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
133 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
134 #define CLI_FULL_CONNECTION_FORCE_DOS_ERRORS 0x0080
135 #define CLI_FULL_CONNECTION_FORCE_ASCII 0x0100
136 #define CLI_FULL_CONNECTION_USE_NT_HASH 0x0200
137
138 #endif /* _CLIENT_H */