docs: Remove find_missing_manpages replaced by docs.py and dependent on a Makefile...
[Samba.git] / source3 / include / client.h
blob35fa2f178acd2b39ab0025f7338de163299513c3
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
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/>.
22 #ifndef _CLIENT_H
23 #define _CLIENT_H
25 #define CLI_BUFFER_SIZE (0xFFFF)
27 /* default client timeout to 20 seconds on most commands */
28 #define CLIENT_TIMEOUT (20 * 1000)
31 * These definitions depend on smb.h
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;
43 struct smbXcli_conn;
44 struct smbXcli_session;
46 struct cli_state {
47 /**
48 * A list of subsidiary connections for DFS.
50 struct cli_state *prev, *next;
51 int rap_error;
52 NTSTATUS raw_status; /* maybe via NT_STATUS_DOS() */
53 bool map_dos_errors;
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. */
61 * The following strings are the
62 * ones returned by the server if
63 * the protocol > NT1.
65 char *server_type;
66 char *server_os;
67 char *server_domain;
69 char *share;
70 char *dev;
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;
81 /* The list of pipes currently open on this connection. */
82 struct rpc_pipe_client *pipe_list;
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. */
90 bool use_oplocks; /* should we use oplocks? */
92 /* Where (if anywhere) this is mounted under DFS. */
93 char *dfs_mountpoint;
95 struct smbXcli_conn *conn;
96 const char *remote_realm;
98 struct {
99 uint16_t pid;
100 uint16_t vc_num;
101 struct smbXcli_session *session;
102 struct smbXcli_tcon *tcon;
103 } smb1;
105 struct {
106 struct smbXcli_session *session;
107 struct smbXcli_tcon *tcon;
108 struct idr_context *open_handles;
109 } smb2;
112 struct file_info {
113 uint64_t size;
114 uint16 mode;
115 uid_t uid;
116 gid_t gid;
117 /* these times are normally kept in GMT */
118 struct timespec mtime_ts;
119 struct timespec atime_ts;
120 struct timespec ctime_ts;
121 char *name;
122 char *short_name;
125 #define CLI_FULL_CONNECTION_DONT_SPNEGO 0x0001
126 #define CLI_FULL_CONNECTION_USE_KERBEROS 0x0002
127 #define CLI_FULL_CONNECTION_ANONYMOUS_FALLBACK 0x0004
128 #define CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS 0x0008
129 #define CLI_FULL_CONNECTION_OPLOCKS 0x0010
130 #define CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS 0x0020
131 #define CLI_FULL_CONNECTION_USE_CCACHE 0x0040
132 #define CLI_FULL_CONNECTION_FORCE_DOS_ERRORS 0x0080
133 #define CLI_FULL_CONNECTION_FORCE_ASCII 0x0100
134 #define CLI_FULL_CONNECTION_USE_NT_HASH 0x0200
136 #endif /* _CLIENT_H */