[linux-block.git] / fs / cifs / fs_context.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *   Copyright (C) 2020, Microsoft Corporation.
 *
 *   Author(s): Steve French <stfrench@microsoft.com>
 *              David Howells <dhowells@redhat.com>
 */

#ifndef _FS_CONTEXT_H
#define _FS_CONTEXT_H

#include "cifsglob.h"
#include <linux/parser.h>
#include <linux/fs_parser.h>

/* Log errors in fs_context (new mount api) but also in dmesg (old style) */
#define cifs_errorf(fc, fmt, ...)			\
	do {						\
		errorf(fc, fmt, ## __VA_ARGS__);	\
		cifs_dbg(VFS, fmt, ## __VA_ARGS__);	\
	} while (0)

enum smb_version {
	Smb_1 = 1,
	Smb_20,
	Smb_21,
	Smb_30,
	Smb_302,
	Smb_311,
	Smb_3any,
	Smb_default,
	Smb_version_err
};

enum {
	Opt_cache_loose,
	Opt_cache_strict,
	Opt_cache_none,
	Opt_cache_ro,
	Opt_cache_rw,
	Opt_cache_err
};

enum cifs_sec_param {
	Opt_sec_krb5,
	Opt_sec_krb5i,
	Opt_sec_krb5p,
	Opt_sec_ntlmsspi,
	Opt_sec_ntlmssp,
	Opt_sec_ntlmv2,
	Opt_sec_ntlmv2i,
	Opt_sec_none,

	Opt_sec_err
};

enum cifs_param {
	/* Mount options that take no arguments */
	Opt_user_xattr,
	Opt_forceuid,
	Opt_forcegid,
	Opt_noblocksend,
	Opt_noautotune,
	Opt_nolease,
	Opt_nosparse,
	Opt_hard,
	Opt_soft,
	Opt_perm,
	Opt_nodelete,
	Opt_mapposix,
	Opt_mapchars,
	Opt_nomapchars,
	Opt_sfu,
	Opt_nodfs,
	Opt_posixpaths,
	Opt_unix,
	Opt_nocase,
	Opt_brl,
	Opt_handlecache,
	Opt_forcemandatorylock,
	Opt_setuidfromacl,
	Opt_setuids,
	Opt_dynperm,
	Opt_intr,
	Opt_strictsync,
	Opt_serverino,
	Opt_rwpidforward,
	Opt_cifsacl,
	Opt_acl,
	Opt_locallease,
	Opt_sign,
	Opt_ignore_signature,
	Opt_seal,
	Opt_noac,
	Opt_fsc,
	Opt_mfsymlinks,
	Opt_multiuser,
	Opt_sloppy,
	Opt_nosharesock,
	Opt_persistent,
	Opt_resilient,
	Opt_tcp_nodelay,
	Opt_domainauto,
	Opt_rdma,
	Opt_modesid,
	Opt_rootfs,
	Opt_multichannel,
	Opt_compress,
	Opt_witness,

	/* Mount options which take numeric value */
	Opt_backupuid,
	Opt_backupgid,
	Opt_uid,
	Opt_cruid,
	Opt_gid,
	Opt_port,
	Opt_file_mode,
	Opt_dirmode,
	Opt_min_enc_offload,
	Opt_blocksize,
	Opt_rasize,
	Opt_rsize,
	Opt_wsize,
	Opt_actimeo,
	Opt_acdirmax,
	Opt_acregmax,
	Opt_closetimeo,
	Opt_echo_interval,
	Opt_max_credits,
	Opt_snapshot,
	Opt_max_channels,
	Opt_handletimeout,

	/* Mount options which take string value */
	Opt_source,
	Opt_user,
	Opt_pass,
	Opt_ip,
	Opt_domain,
	Opt_srcaddr,
	Opt_iocharset,
	Opt_netbiosname,
	Opt_servern,
	Opt_ver,
	Opt_vers,
	Opt_sec,
	Opt_cache,

	/* Mount options to be ignored */
	Opt_ignore,

	Opt_err
};

struct smb3_fs_context {
	bool uid_specified;
	bool cruid_specified;
	bool gid_specified;
	bool sloppy;
	bool got_ip;
	bool got_version;
	bool got_rsize;
	bool got_wsize;
	bool got_bsize;
	unsigned short port;

	char *username;
	char *password;
	char *domainname;
	char *source;
	char *server_hostname;
	char *UNC;
	char *nodename;
	char workstation_name[CIFS_MAX_WORKSTATION_LEN];
	char *iocharset;  /* local code page for mapping to and from Unicode */
	char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
	char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
	kuid_t cred_uid;
	kuid_t linux_uid;
	kgid_t linux_gid;
	kuid_t backupuid;
	kgid_t backupgid;
	umode_t file_mode;
	umode_t dir_mode;
	enum securityEnum sectype; /* sectype requested via mnt opts */
	bool sign; /* was signing requested via mnt opts? */
	bool ignore_signature:1;
	bool retry:1;
	bool intr:1;
	bool setuids:1;
	bool setuidfromacl:1;
	bool override_uid:1;
	bool override_gid:1;
	bool dynperm:1;
	bool noperm:1;
	bool nodelete:1;
	bool mode_ace:1;
	bool no_psx_acl:1; /* set if posix acl support should be disabled */
	bool cifs_acl:1;
	bool backupuid_specified; /* mount option  backupuid  is specified */
	bool backupgid_specified; /* mount option  backupgid  is specified */
	bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
	bool server_ino:1; /* use inode numbers from server ie UniqueId */
	bool direct_io:1;
	bool strict_io:1; /* strict cache behavior */
	bool cache_ro:1;
	bool cache_rw:1;
	bool remap:1;      /* set to remap seven reserved chars in filenames */
	bool sfu_remap:1;  /* remap seven reserved chars ala SFU */
	bool posix_paths:1; /* unset to not ask for posix pathnames. */
	bool no_linux_ext:1;
	bool linux_ext:1;
	bool sfu_emul:1;
	bool nullauth:1;   /* attempt to authenticate with null user */
	bool nocase:1;     /* request case insensitive filenames */
	bool nobrl:1;      /* disable sending byte range locks to srv */
	bool nohandlecache:1; /* disable caching dir handles if srvr probs */
	bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
	bool seal:1;       /* request transport encryption on share */
	bool nodfs:1;      /* Do not request DFS, even if available */
	bool local_lease:1; /* check leases only on local system, not remote */
	bool noblocksnd:1;
	bool noautotune:1;
	bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
	bool no_lease:1;     /* disable requesting leases */
	bool no_sparse:1;    /* do not attempt to set files sparse */
	bool fsc:1;	/* enable fscache */
	bool mfsymlinks:1; /* use Minshall+French Symlinks */
	bool multiuser:1;
	bool rwpidforward:1; /* pid forward for read/write operations */
	bool nosharesock:1;
	bool persistent:1;
	bool nopersistent:1;
	bool resilient:1; /* noresilient not required since not fored for CA */
	bool domainauto:1;
	bool rdma:1;
	bool multichannel:1;
	bool use_client_guid:1;
	/* reuse existing guid for multichannel */
	u8 client_guid[SMB2_CLIENT_GUID_SIZE];
	unsigned int bsize;
	unsigned int rasize;
	unsigned int rsize;
	unsigned int wsize;
	unsigned int min_offload;
	bool sockopt_tcp_nodelay:1;
	/* attribute cache timemout for files and directories in jiffies */
	unsigned long acregmax;
	unsigned long acdirmax;
	/* timeout for deferred close of files in jiffies */
	unsigned long closetimeo;
	struct smb_version_operations *ops;
	struct smb_version_values *vals;
	char *prepath;
	struct sockaddr_storage dstaddr; /* destination address */
	struct sockaddr_storage srcaddr; /* allow binding to a local IP */
	struct nls_table *local_nls; /* This is a copy of the pointer in cifs_sb */
	unsigned int echo_interval; /* echo interval in secs */
	__u64 snapshot_time; /* needed for timewarp tokens */
	__u32 handle_timeout; /* persistent and durable handle timeout in ms */
	unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
	unsigned int max_channels;
	__u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
	bool rootfs:1; /* if it's a SMB root file system */
	bool witness:1; /* use witness protocol */
	char *leaf_fullpath;
	struct cifs_ses *dfs_root_ses;
};

extern const struct fs_parameter_spec smb3_fs_parameters[];

extern int smb3_init_fs_context(struct fs_context *fc);
extern void smb3_cleanup_fs_context_contents(struct smb3_fs_context *ctx);
extern void smb3_cleanup_fs_context(struct smb3_fs_context *ctx);

static inline struct smb3_fs_context *smb3_fc2context(const struct fs_context *fc)
{
	return fc->fs_private;
}

extern int smb3_fs_context_dup(struct smb3_fs_context *new_ctx, struct smb3_fs_context *ctx);
extern void smb3_update_mnt_flags(struct cifs_sb_info *cifs_sb);

/*
 * max deferred close timeout (jiffies) - 2^30
 */
#define SMB3_MAX_DCLOSETIMEO (1 << 30)
#define SMB3_DEF_DCLOSETIMEO (1 * HZ) /* even 1 sec enough to help eg open/write/close/open/read */

extern char *cifs_sanitize_prepath(char *prepath, gfp_t gfp);

#endif
Commit	Line	Data
a6a9cffa RS	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
5c6e5aa4	12	#include "cifsglob.h"
24e0a1ef RS	13	#include <linux/parser.h>
	14	#include <linux/fs_parser.h>
	15
9d4ac8b6 AA	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)
a6a9cffa	22
555782aa RS	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
2f20f076 RS	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
5c6e5aa4 RS	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,
5c6e5aa4 RS	50	Opt_sec_ntlmv2,
5c6e5aa4 RS	51	Opt_sec_ntlmv2i,
5c6e5aa4	52	Opt_sec_none,
a6a9cffa	53
5c6e5aa4 RS	54	Opt_sec_err
	55	};
	56
15c7d09a RS	57	enum cifs_param {
15c7d09a RS	58	/* Mount options that take no arguments */
24e0a1ef RS	59	Opt_user_xattr,
	60	Opt_forceuid,
	61	Opt_forcegid,
15c7d09a RS	62	Opt_noblocksend,
	63	Opt_noautotune,
	64	Opt_nolease,
52832252	65	Opt_nosparse,
24e0a1ef RS	66	Opt_hard,
	67	Opt_soft,
	68	Opt_perm,
15c7d09a	69	Opt_nodelete,
24e0a1ef	70	Opt_mapposix,
15c7d09a RS	71	Opt_mapchars,
15c7d09a RS	72	Opt_nomapchars,
24e0a1ef	73	Opt_sfu,
15c7d09a	74	Opt_nodfs,
24e0a1ef RS	75	Opt_posixpaths,
24e0a1ef RS	76	Opt_unix,
15c7d09a	77	Opt_nocase,
24e0a1ef RS	78	Opt_brl,
24e0a1ef RS	79	Opt_handlecache,
15c7d09a RS	80	Opt_forcemandatorylock,
15c7d09a RS	81	Opt_setuidfromacl,
24e0a1ef RS	82	Opt_setuids,
	83	Opt_dynperm,
	84	Opt_intr,
	85	Opt_strictsync,
	86	Opt_serverino,
15c7d09a	87	Opt_rwpidforward,
24e0a1ef RS	88	Opt_cifsacl,
24e0a1ef RS	89	Opt_acl,
15c7d09a RS	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,
24e0a1ef RS	100	Opt_persistent,
24e0a1ef RS	101	Opt_resilient,
7ae5e588	102	Opt_tcp_nodelay,
15c7d09a RS	103	Opt_domainauto,
	104	Opt_rdma,
	105	Opt_modesid,
	106	Opt_rootfs,
24e0a1ef	107	Opt_multichannel,
15c7d09a	108	Opt_compress,
0ac4e291	109	Opt_witness,
15c7d09a RS	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,
b8d64f8c	122	Opt_rasize,
15c7d09a RS	123	Opt_rsize,
	124	Opt_wsize,
	125	Opt_actimeo,
4c9f9481	126	Opt_acdirmax,
57804646	127	Opt_acregmax,
5efdd912	128	Opt_closetimeo,
15c7d09a RS	129	Opt_echo_interval,
	130	Opt_max_credits,
	131	Opt_snapshot,
	132	Opt_max_channels,
	133	Opt_handletimeout,
	134
	135	/* Mount options which take string value */
	136	Opt_source,
	137	Opt_user,
	138	Opt_pass,
	139	Opt_ip,
	140	Opt_domain,
	141	Opt_srcaddr,
	142	Opt_iocharset,
	143	Opt_netbiosname,
	144	Opt_servern,
	145	Opt_ver,
	146	Opt_vers,
	147	Opt_sec,
	148	Opt_cache,
	149
	150	/* Mount options to be ignored */
	151	Opt_ignore,
	152
15c7d09a RS	153	Opt_err
	154	};
	155
3fa1c6d1 RS	156	struct smb3_fs_context {
3fa1c6d1 RS	157	bool uid_specified;
e0a3cbcd	158	bool cruid_specified;
3fa1c6d1 RS	159	bool gid_specified;
3fa1c6d1 RS	160	bool sloppy;
3fa1c6d1 RS	161	bool got_ip;
3fa1c6d1 RS	162	bool got_version;
522aa3b5 RS	163	bool got_rsize;
	164	bool got_wsize;
	165	bool got_bsize;
3fa1c6d1 RS	166	unsigned short port;
	167
	168	char *username;
	169	char *password;
	170	char *domainname;
af1a3d2b	171	char *source;
7be3248f	172	char *server_hostname;
3fa1c6d1	173	char *UNC;
9ccecae8	174	char *nodename;
de3a9e94	175	char workstation_name[CIFS_MAX_WORKSTATION_LEN];
3fa1c6d1 RS	176	char iocharset; / local code page for mapping to and from Unicode */
	177	char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
	178	char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
	179	kuid_t cred_uid;
	180	kuid_t linux_uid;
	181	kgid_t linux_gid;
	182	kuid_t backupuid;
	183	kgid_t backupgid;
	184	umode_t file_mode;
	185	umode_t dir_mode;
	186	enum securityEnum sectype; /* sectype requested via mnt opts */
	187	bool sign; /* was signing requested via mnt opts? */
	188	bool ignore_signature:1;
	189	bool retry:1;
	190	bool intr:1;
	191	bool setuids:1;
	192	bool setuidfromacl:1;
	193	bool override_uid:1;
	194	bool override_gid:1;
	195	bool dynperm:1;
	196	bool noperm:1;
	197	bool nodelete:1;
	198	bool mode_ace:1;
	199	bool no_psx_acl:1; /* set if posix acl support should be disabled */
	200	bool cifs_acl:1;
	201	bool backupuid_specified; /* mount option backupuid is specified */
	202	bool backupgid_specified; /* mount option backupgid is specified */
	203	bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
	204	bool server_ino:1; /* use inode numbers from server ie UniqueId */
	205	bool direct_io:1;
	206	bool strict_io:1; /* strict cache behavior */
	207	bool cache_ro:1;
	208	bool cache_rw:1;
	209	bool remap:1; /* set to remap seven reserved chars in filenames */
	210	bool sfu_remap:1; /* remap seven reserved chars ala SFU */
	211	bool posix_paths:1; /* unset to not ask for posix pathnames. */
	212	bool no_linux_ext:1;
	213	bool linux_ext:1;
	214	bool sfu_emul:1;
	215	bool nullauth:1; /* attempt to authenticate with null user */
	216	bool nocase:1; /* request case insensitive filenames */
	217	bool nobrl:1; /* disable sending byte range locks to srv */
	218	bool nohandlecache:1; /* disable caching dir handles if srvr probs */
	219	bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
	220	bool seal:1; /* request transport encryption on share */
	221	bool nodfs:1; /* Do not request DFS, even if available */
	222	bool local_lease:1; /* check leases only on local system, not remote */
	223	bool noblocksnd:1;
	224	bool noautotune:1;
	225	bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
	226	bool no_lease:1; /* disable requesting leases */
52832252	227	bool no_sparse:1; /* do not attempt to set files sparse */
3fa1c6d1 RS	228	bool fsc:1; /* enable fscache */
	229	bool mfsymlinks:1; /* use Minshall+French Symlinks */
	230	bool multiuser:1;
	231	bool rwpidforward:1; /* pid forward for read/write operations */
	232	bool nosharesock:1;
	233	bool persistent:1;
	234	bool nopersistent:1;
	235	bool resilient:1; /* noresilient not required since not fored for CA */
	236	bool domainauto:1;
	237	bool rdma:1;
	238	bool multichannel:1;
	239	bool use_client_guid:1;
	240	/* reuse existing guid for multichannel */
	241	u8 client_guid[SMB2_CLIENT_GUID_SIZE];
	242	unsigned int bsize;
b8d64f8c	243	unsigned int rasize;
3fa1c6d1 RS	244	unsigned int rsize;
	245	unsigned int wsize;
	246	unsigned int min_offload;
	247	bool sockopt_tcp_nodelay:1;
57804646 SF	248	/* attribute cache timemout for files and directories in jiffies */
	249	unsigned long acregmax;
	250	unsigned long acdirmax;
5efdd912 SF	251	/* timeout for deferred close of files in jiffies */
5efdd912 SF	252	unsigned long closetimeo;
3fa1c6d1 RS	253	struct smb_version_operations *ops;
	254	struct smb_version_values *vals;
	255	char *prepath;
	256	struct sockaddr_storage dstaddr; /* destination address */
	257	struct sockaddr_storage srcaddr; /* allow binding to a local IP */
387ec58f	258	struct nls_table local_nls; / This is a copy of the pointer in cifs_sb */
3fa1c6d1 RS	259	unsigned int echo_interval; /* echo interval in secs */
	260	__u64 snapshot_time; /* needed for timewarp tokens */
	261	__u32 handle_timeout; /* persistent and durable handle timeout in ms */
	262	unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
	263	unsigned int max_channels;
	264	__u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
	265	bool rootfs:1; /* if it's a SMB root file system */
0ac4e291	266	bool witness:1; /* use witness protocol */
a1c0d005	267	char *leaf_fullpath;
b56bce50	268	struct cifs_ses *dfs_root_ses;
3fa1c6d1 RS	269	};
3fa1c6d1 RS	270
24e0a1ef RS	271	extern const struct fs_parameter_spec smb3_fs_parameters[];
24e0a1ef RS	272
24e0a1ef	273	extern int smb3_init_fs_context(struct fs_context *fc);
c741cba2 RS	274	extern void smb3_cleanup_fs_context_contents(struct smb3_fs_context *ctx);
c741cba2 RS	275	extern void smb3_cleanup_fs_context(struct smb3_fs_context *ctx);
24e0a1ef RS	276
	277	static inline struct smb3_fs_context smb3_fc2context(const struct fs_context fc)
	278	{
	279	return fc->fs_private;
	280	}
	281
837e3a1b	282	extern int smb3_fs_context_dup(struct smb3_fs_context new_ctx, struct smb3_fs_context ctx);
2d39f50c	283	extern void smb3_update_mnt_flags(struct cifs_sb_info *cifs_sb);
a6a9cffa	284
5efdd912 SF	285	/*
	286	* max deferred close timeout (jiffies) - 2^30
	287	*/
	288	#define SMB3_MAX_DCLOSETIMEO (1 << 30)
7e0e76d9	289	#define SMB3_DEF_DCLOSETIMEO (1 * HZ) /* even 1 sec enough to help eg open/write/close/open/read */
d19342c6 TRB	290
	291	extern char cifs_sanitize_prepath(char prepath, gfp_t gfp);
	292
5c6e5aa4	293	#endif