30e0fae87441ad1f449ed5a2862f7b9c363a8dcf
[ira/wip.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 2 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, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #ifndef _CLIENT_H
24 #define _CLIENT_H
25
26 /* the client asks for a smaller buffer to save ram and also to get more
27    overlap on the wire. This size gives us a nice read/write size, which
28    will be a multiple of the page size on almost any system */
29 #define CLI_BUFFER_SIZE (0xFFFF)
30 #define CLI_MAX_LARGE_READX_SIZE (127*1024)
31
32 /*
33  * These definitions depend on smb.h
34  */
35
36 typedef struct file_info
37 {
38         SMB_BIG_UINT size;
39         uint16 mode;
40         uid_t uid;
41         gid_t gid;
42         /* these times are normally kept in GMT */
43         time_t mtime;
44         time_t atime;
45         time_t ctime;
46         pstring name;
47         pstring dir;
48         char short_name[13*3]; /* the *3 is to cope with multi-byte */
49 } file_info;
50
51 struct print_job_info
52 {
53         uint16 id;
54         uint16 priority;
55         size_t size;
56         fstring user;
57         fstring name;
58         time_t t;
59 };
60
61 struct cli_pipe_auth_data {
62         enum pipe_auth_type auth_type; /* switch for the union below. Defined in ntdomain.h */
63         enum pipe_auth_level auth_level; /* defined in ntdomain.h */
64         union {
65                 struct schannel_auth_struct *schannel_auth;
66                 NTLMSSP_STATE *ntlmssp_state;
67                 struct kerberos_auth_struct *kerberos_auth;
68         } a_u;
69         void (*cli_auth_data_free_func)(struct cli_pipe_auth_data *);
70 };
71
72 struct rpc_pipe_client {
73         struct rpc_pipe_client *prev, *next;
74
75         TALLOC_CTX *mem_ctx;
76
77         struct cli_state *cli;
78
79         int pipe_idx;
80         const char *pipe_name;
81         uint16 fnum;
82
83         const char *domain;
84         const char *user_name;
85         struct pwd_info pwd;
86
87         uint16 max_xmit_frag;
88         uint16 max_recv_frag;
89
90         struct cli_pipe_auth_data auth;
91
92         /* The following is only non-null on a netlogon pipe. */
93         struct dcinfo *dc;
94 };
95
96 struct cli_state {
97         int port;
98         int fd;
99         int smb_rw_error; /* Copy of last read or write error. */
100         uint16 cnum;
101         uint16 pid;
102         uint16 mid;
103         uint16 vuid;
104         int protocol;
105         int sec_mode;
106         int rap_error;
107         int privileges;
108
109         fstring desthost;
110
111         /* The credentials used to open the cli_state connection. */
112         fstring domain;
113         fstring user_name;
114         struct pwd_info pwd;
115
116         /*
117          * The following strings are the
118          * ones returned by the server if
119          * the protocol > NT1.
120          */
121         fstring server_type;
122         fstring server_os;
123         fstring server_domain;
124
125         fstring share;
126         fstring dev;
127         struct nmb_name called;
128         struct nmb_name calling;
129         fstring full_dest_host_name;
130         struct in_addr dest_ip;
131
132         DATA_BLOB secblob; /* cryptkey or negTokenInit */
133         uint32 sesskey;
134         int serverzone;
135         uint32 servertime;
136         int readbraw_supported;
137         int writebraw_supported;
138         int timeout; /* in milliseconds. */
139         size_t max_xmit;
140         size_t max_mux;
141         char *outbuf;
142         char *inbuf;
143         unsigned int bufsize;
144         int initialised;
145         int win95;
146         uint32 capabilities;
147         BOOL dfsroot;
148
149         TALLOC_CTX *mem_ctx;
150
151         smb_sign_info sign_info;
152
153         /* the session key for this CLI, outside 
154            any per-pipe authenticaion */
155         DATA_BLOB user_session_key;
156
157         /* The list of pipes currently open on this connection. */
158         struct rpc_pipe_client *pipe_list;
159
160         BOOL use_kerberos;
161         BOOL fallback_after_kerberos;
162         BOOL use_spnego;
163
164         BOOL use_oplocks; /* should we use oplocks? */
165         BOOL use_level_II_oplocks; /* should we use level II oplocks? */
166
167         /* a oplock break request handler */
168         BOOL (*oplock_handler)(struct cli_state *cli, int fnum, unsigned char level);
169
170         BOOL force_dos_errors;
171         BOOL case_sensitive; /* False by default. */
172
173         /* was this structure allocated by cli_initialise? If so, then
174            free in cli_shutdown() */
175         BOOL allocated;
176 };
177
178 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
179 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
180 #define CLI_FULL_CONNECTION_ANNONYMOUS_FALLBACK 0x0004
181
182 #endif /* _CLIENT_H */