xref: /openbmc/linux/fs/smb/client/fs_context.h (revision 5e2af67d84450903d6a37df72a82e81ecc899eba)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *   Copyright (C) 2020, Microsoft Corporation.
4  *
5  *   Author(s): Steve French <stfrench@microsoft.com>
6  *              David Howells <dhowells@redhat.com>
7  */
8 
9 #ifndef _FS_CONTEXT_H
10 #define _FS_CONTEXT_H
11 
12 #include "cifsglob.h"
13 #include <linux/parser.h>
14 #include <linux/fs_parser.h>
15 
16 /* Log errors in fs_context (new mount api) but also in dmesg (old style) */
17 #define cifs_errorf(fc, fmt, ...)			\
18 	do {						\
19 		errorf(fc, fmt, ## __VA_ARGS__);	\
20 		cifs_dbg(VFS, fmt, ## __VA_ARGS__);	\
21 	} while (0)
22 
23 enum smb_version {
24 	Smb_1 = 1,
25 	Smb_20,
26 	Smb_21,
27 	Smb_30,
28 	Smb_302,
29 	Smb_311,
30 	Smb_3any,
31 	Smb_default,
32 	Smb_version_err
33 };
34 
35 enum {
36 	Opt_cache_loose,
37 	Opt_cache_strict,
38 	Opt_cache_none,
39 	Opt_cache_ro,
40 	Opt_cache_rw,
41 	Opt_cache_err
42 };
43 
44 enum cifs_sec_param {
45 	Opt_sec_krb5,
46 	Opt_sec_krb5i,
47 	Opt_sec_krb5p,
48 	Opt_sec_ntlmsspi,
49 	Opt_sec_ntlmssp,
50 	Opt_sec_ntlmv2,
51 	Opt_sec_ntlmv2i,
52 	Opt_sec_none,
53 
54 	Opt_sec_err
55 };
56 
57 enum cifs_param {
58 	/* Mount options that take no arguments */
59 	Opt_user_xattr,
60 	Opt_forceuid,
61 	Opt_forcegid,
62 	Opt_noblocksend,
63 	Opt_noautotune,
64 	Opt_nolease,
65 	Opt_nosparse,
66 	Opt_hard,
67 	Opt_soft,
68 	Opt_perm,
69 	Opt_nodelete,
70 	Opt_mapposix,
71 	Opt_mapchars,
72 	Opt_nomapchars,
73 	Opt_sfu,
74 	Opt_nodfs,
75 	Opt_posixpaths,
76 	Opt_unix,
77 	Opt_nocase,
78 	Opt_brl,
79 	Opt_handlecache,
80 	Opt_forcemandatorylock,
81 	Opt_setuidfromacl,
82 	Opt_setuids,
83 	Opt_dynperm,
84 	Opt_intr,
85 	Opt_strictsync,
86 	Opt_serverino,
87 	Opt_rwpidforward,
88 	Opt_cifsacl,
89 	Opt_acl,
90 	Opt_locallease,
91 	Opt_sign,
92 	Opt_ignore_signature,
93 	Opt_seal,
94 	Opt_noac,
95 	Opt_fsc,
96 	Opt_mfsymlinks,
97 	Opt_multiuser,
98 	Opt_sloppy,
99 	Opt_nosharesock,
100 	Opt_persistent,
101 	Opt_resilient,
102 	Opt_tcp_nodelay,
103 	Opt_domainauto,
104 	Opt_rdma,
105 	Opt_modesid,
106 	Opt_rootfs,
107 	Opt_multichannel,
108 	Opt_compress,
109 	Opt_witness,
110 
111 	/* Mount options which take numeric value */
112 	Opt_backupuid,
113 	Opt_backupgid,
114 	Opt_uid,
115 	Opt_cruid,
116 	Opt_gid,
117 	Opt_port,
118 	Opt_file_mode,
119 	Opt_dirmode,
120 	Opt_min_enc_offload,
121 	Opt_blocksize,
122 	Opt_rasize,
123 	Opt_rsize,
124 	Opt_wsize,
125 	Opt_actimeo,
126 	Opt_acdirmax,
127 	Opt_acregmax,
128 	Opt_closetimeo,
129 	Opt_echo_interval,
130 	Opt_max_credits,
131 	Opt_max_cached_dirs,
132 	Opt_snapshot,
133 	Opt_max_channels,
134 	Opt_handletimeout,
135 
136 	/* Mount options which take string value */
137 	Opt_source,
138 	Opt_user,
139 	Opt_pass,
140 	Opt_pass2,
141 	Opt_ip,
142 	Opt_domain,
143 	Opt_srcaddr,
144 	Opt_iocharset,
145 	Opt_netbiosname,
146 	Opt_servern,
147 	Opt_ver,
148 	Opt_vers,
149 	Opt_sec,
150 	Opt_cache,
151 
152 	/* Mount options to be ignored */
153 	Opt_ignore,
154 
155 	Opt_err
156 };
157 
158 struct smb3_fs_context {
159 	bool forceuid_specified;
160 	bool forcegid_specified;
161 	bool uid_specified;
162 	bool cruid_specified;
163 	bool gid_specified;
164 	bool sloppy;
165 	bool got_ip;
166 	bool got_version;
167 	bool got_rsize;
168 	bool got_wsize;
169 	bool got_bsize;
170 	unsigned short port;
171 
172 	char *username;
173 	char *password;
174 	char *password2;
175 	char *domainname;
176 	char *source;
177 	char *server_hostname;
178 	char *UNC;
179 	char *nodename;
180 	char workstation_name[CIFS_MAX_WORKSTATION_LEN];
181 	char *iocharset;  /* local code page for mapping to and from Unicode */
182 	char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
183 	char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
184 	kuid_t cred_uid;
185 	kuid_t linux_uid;
186 	kgid_t linux_gid;
187 	kuid_t backupuid;
188 	kgid_t backupgid;
189 	umode_t file_mode;
190 	umode_t dir_mode;
191 	enum securityEnum sectype; /* sectype requested via mnt opts */
192 	bool sign; /* was signing requested via mnt opts? */
193 	bool ignore_signature:1;
194 	bool retry:1;
195 	bool intr:1;
196 	bool setuids:1;
197 	bool setuidfromacl:1;
198 	bool override_uid:1;
199 	bool override_gid:1;
200 	bool dynperm:1;
201 	bool noperm:1;
202 	bool nodelete:1;
203 	bool mode_ace:1;
204 	bool no_psx_acl:1; /* set if posix acl support should be disabled */
205 	bool cifs_acl:1;
206 	bool backupuid_specified; /* mount option  backupuid  is specified */
207 	bool backupgid_specified; /* mount option  backupgid  is specified */
208 	bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
209 	bool server_ino:1; /* use inode numbers from server ie UniqueId */
210 	bool direct_io:1;
211 	bool strict_io:1; /* strict cache behavior */
212 	bool cache_ro:1;
213 	bool cache_rw:1;
214 	bool remap:1;      /* set to remap seven reserved chars in filenames */
215 	bool sfu_remap:1;  /* remap seven reserved chars ala SFU */
216 	bool posix_paths:1; /* unset to not ask for posix pathnames. */
217 	bool no_linux_ext:1;
218 	bool linux_ext:1;
219 	bool sfu_emul:1;
220 	bool nullauth:1;   /* attempt to authenticate with null user */
221 	bool nocase:1;     /* request case insensitive filenames */
222 	bool nobrl:1;      /* disable sending byte range locks to srv */
223 	bool nohandlecache:1; /* disable caching dir handles if srvr probs */
224 	bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
225 	bool seal:1;       /* request transport encryption on share */
226 	bool nodfs:1;      /* Do not request DFS, even if available */
227 	bool local_lease:1; /* check leases only on local system, not remote */
228 	bool noblocksnd:1;
229 	bool noautotune:1;
230 	bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
231 	bool no_lease:1;     /* disable requesting leases */
232 	bool no_sparse:1;    /* do not attempt to set files sparse */
233 	bool fsc:1;	/* enable fscache */
234 	bool mfsymlinks:1; /* use Minshall+French Symlinks */
235 	bool multiuser:1;
236 	bool rwpidforward:1; /* pid forward for read/write operations */
237 	bool nosharesock:1;
238 	bool persistent:1;
239 	bool nopersistent:1;
240 	bool resilient:1; /* noresilient not required since not fored for CA */
241 	bool domainauto:1;
242 	bool rdma:1;
243 	bool multichannel:1;
244 	bool use_client_guid:1;
245 	/* reuse existing guid for multichannel */
246 	u8 client_guid[SMB2_CLIENT_GUID_SIZE];
247 	unsigned int bsize;
248 	unsigned int rasize;
249 	unsigned int rsize;
250 	unsigned int wsize;
251 	unsigned int min_offload;
252 	bool sockopt_tcp_nodelay:1;
253 	/* attribute cache timemout for files and directories in jiffies */
254 	unsigned long acregmax;
255 	unsigned long acdirmax;
256 	/* timeout for deferred close of files in jiffies */
257 	unsigned long closetimeo;
258 	struct smb_version_operations *ops;
259 	struct smb_version_values *vals;
260 	char *prepath;
261 	struct sockaddr_storage dstaddr; /* destination address */
262 	struct sockaddr_storage srcaddr; /* allow binding to a local IP */
263 	struct nls_table *local_nls; /* This is a copy of the pointer in cifs_sb */
264 	unsigned int echo_interval; /* echo interval in secs */
265 	__u64 snapshot_time; /* needed for timewarp tokens */
266 	__u32 handle_timeout; /* persistent and durable handle timeout in ms */
267 	unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
268 	unsigned int max_channels;
269 	unsigned int max_cached_dirs;
270 	__u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
271 	bool rootfs:1; /* if it's a SMB root file system */
272 	bool witness:1; /* use witness protocol */
273 	char *leaf_fullpath;
274 	struct cifs_ses *dfs_root_ses;
275 	bool dfs_automount:1; /* set for dfs automount only */
276 };
277 
278 extern const struct fs_parameter_spec smb3_fs_parameters[];
279 
280 extern int smb3_init_fs_context(struct fs_context *fc);
281 extern void smb3_cleanup_fs_context_contents(struct smb3_fs_context *ctx);
282 extern void smb3_cleanup_fs_context(struct smb3_fs_context *ctx);
283 
284 static inline struct smb3_fs_context *smb3_fc2context(const struct fs_context *fc)
285 {
286 	return fc->fs_private;
287 }
288 
289 extern int smb3_fs_context_dup(struct smb3_fs_context *new_ctx, struct smb3_fs_context *ctx);
290 extern void smb3_update_mnt_flags(struct cifs_sb_info *cifs_sb);
291 
292 /*
293  * max deferred close timeout (jiffies) - 2^30
294  */
295 #define SMB3_MAX_DCLOSETIMEO (1 << 30)
296 #define SMB3_DEF_DCLOSETIMEO (1 * HZ) /* even 1 sec enough to help eg open/write/close/open/read */
297 #define MAX_CACHED_FIDS 16
298 extern char *cifs_sanitize_prepath(char *prepath, gfp_t gfp);
299 
300 extern struct mutex cifs_mount_mutex;
301 
302 static inline void cifs_mount_lock(void)
303 {
304 	mutex_lock(&cifs_mount_mutex);
305 }
306 
307 static inline void cifs_mount_unlock(void)
308 {
309 	mutex_unlock(&cifs_mount_mutex);
310 }
311 
312 #endif
313