fs/cifs/fs_context.h

   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 #define cifs_invalf(fc, fmt, ...) invalf(fc, fmt, ## __VA_ARGS__)
  17
  18 enum smb_version {
  19         Smb_1 = 1,
  20         Smb_20,
  21         Smb_21,
  22         Smb_30,
  23         Smb_302,
  24         Smb_311,
  25         Smb_3any,
  26         Smb_default,
  27         Smb_version_err
  28 };
  29
  30 enum {
  31         Opt_cache_loose,
  32         Opt_cache_strict,
  33         Opt_cache_none,
  34         Opt_cache_ro,
  35         Opt_cache_rw,
  36         Opt_cache_err
  37 };
  38
  39 enum cifs_sec_param {
  40         Opt_sec_krb5,
  41         Opt_sec_krb5i,
  42         Opt_sec_krb5p,
  43         Opt_sec_ntlmsspi,
  44         Opt_sec_ntlmssp,
  45         Opt_ntlm,
  46         Opt_sec_ntlmi,
  47         Opt_sec_ntlmv2,
  48         Opt_sec_ntlmv2i,
  49         Opt_sec_lanman,
  50         Opt_sec_none,
  51
  52         Opt_sec_err
  53 };
  54
  55 enum cifs_param {
  56         /* Mount options that take no arguments */
  57         Opt_user_xattr,
  58         Opt_forceuid,
  59         Opt_forcegid,
  60         Opt_noblocksend,
  61         Opt_noautotune,
  62         Opt_nolease,
  63         Opt_hard,
  64         Opt_soft,
  65         Opt_perm,
  66         Opt_nodelete,
  67         Opt_mapposix,
  68         Opt_mapchars,
  69         Opt_nomapchars,
  70         Opt_sfu,
  71         Opt_nodfs,
  72         Opt_posixpaths,
  73         Opt_unix,
  74         Opt_nocase,
  75         Opt_brl,
  76         Opt_handlecache,
  77         Opt_forcemandatorylock,
  78         Opt_setuidfromacl,
  79         Opt_setuids,
  80         Opt_dynperm,
  81         Opt_intr,
  82         Opt_strictsync,
  83         Opt_serverino,
  84         Opt_rwpidforward,
  85         Opt_cifsacl,
  86         Opt_acl,
  87         Opt_locallease,
  88         Opt_sign,
  89         Opt_ignore_signature,
  90         Opt_seal,
  91         Opt_noac,
  92         Opt_fsc,
  93         Opt_mfsymlinks,
  94         Opt_multiuser,
  95         Opt_sloppy,
  96         Opt_nosharesock,
  97         Opt_persistent,
  98         Opt_resilient,
  99         Opt_domainauto,
 100         Opt_rdma,
 101         Opt_modesid,
 102         Opt_rootfs,
 103         Opt_multichannel,
 104         Opt_compress,
 105         Opt_witness,
 106
 107         /* Mount options which take numeric value */
 108         Opt_backupuid,
 109         Opt_backupgid,
 110         Opt_uid,
 111         Opt_cruid,
 112         Opt_gid,
 113         Opt_port,
 114         Opt_file_mode,
 115         Opt_dirmode,
 116         Opt_min_enc_offload,
 117         Opt_blocksize,
 118         Opt_rsize,
 119         Opt_wsize,
 120         Opt_actimeo,
 121         Opt_echo_interval,
 122         Opt_max_credits,
 123         Opt_snapshot,
 124         Opt_max_channels,
 125         Opt_handletimeout,
 126
 127         /* Mount options which take string value */
 128         Opt_source,
 129         Opt_user,
 130         Opt_pass,
 131         Opt_ip,
 132         Opt_domain,
 133         Opt_srcaddr,
 134         Opt_iocharset,
 135         Opt_netbiosname,
 136         Opt_servern,
 137         Opt_ver,
 138         Opt_vers,
 139         Opt_sec,
 140         Opt_cache,
 141
 142         /* Mount options to be ignored */
 143         Opt_ignore,
 144
 145         Opt_err
 146 };
 147
 148 struct smb3_fs_context {
 149         bool uid_specified;
 150         bool gid_specified;
 151         bool sloppy;
 152         bool got_ip;
 153         bool got_version;
 154         bool got_rsize;
 155         bool got_wsize;
 156         bool got_bsize;
 157         unsigned short port;
 158
 159         char *username;
 160         char *password;
 161         char *domainname;
 162         char *source;
 163         char *UNC;
 164         char *nodename;
 165         char *iocharset;  /* local code page for mapping to and from Unicode */
 166         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
 167         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
 168         kuid_t cred_uid;
 169         kuid_t linux_uid;
 170         kgid_t linux_gid;
 171         kuid_t backupuid;
 172         kgid_t backupgid;
 173         umode_t file_mode;
 174         umode_t dir_mode;
 175         enum securityEnum sectype; /* sectype requested via mnt opts */
 176         bool sign; /* was signing requested via mnt opts? */
 177         bool ignore_signature:1;
 178         bool retry:1;
 179         bool intr:1;
 180         bool setuids:1;
 181         bool setuidfromacl:1;
 182         bool override_uid:1;
 183         bool override_gid:1;
 184         bool dynperm:1;
 185         bool noperm:1;
 186         bool nodelete:1;
 187         bool mode_ace:1;
 188         bool no_psx_acl:1; /* set if posix acl support should be disabled */
 189         bool cifs_acl:1;
 190         bool backupuid_specified; /* mount option  backupuid  is specified */
 191         bool backupgid_specified; /* mount option  backupgid  is specified */
 192         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
 193         bool server_ino:1; /* use inode numbers from server ie UniqueId */
 194         bool direct_io:1;
 195         bool strict_io:1; /* strict cache behavior */
 196         bool cache_ro:1;
 197         bool cache_rw:1;
 198         bool remap:1;      /* set to remap seven reserved chars in filenames */
 199         bool sfu_remap:1;  /* remap seven reserved chars ala SFU */
 200         bool posix_paths:1; /* unset to not ask for posix pathnames. */
 201         bool no_linux_ext:1;
 202         bool linux_ext:1;
 203         bool sfu_emul:1;
 204         bool nullauth:1;   /* attempt to authenticate with null user */
 205         bool nocase:1;     /* request case insensitive filenames */
 206         bool nobrl:1;      /* disable sending byte range locks to srv */
 207         bool nohandlecache:1; /* disable caching dir handles if srvr probs */
 208         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
 209         bool seal:1;       /* request transport encryption on share */
 210         bool nodfs:1;      /* Do not request DFS, even if available */
 211         bool local_lease:1; /* check leases only on local system, not remote */
 212         bool noblocksnd:1;
 213         bool noautotune:1;
 214         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
 215         bool no_lease:1;     /* disable requesting leases */
 216         bool fsc:1;     /* enable fscache */
 217         bool mfsymlinks:1; /* use Minshall+French Symlinks */
 218         bool multiuser:1;
 219         bool rwpidforward:1; /* pid forward for read/write operations */
 220         bool nosharesock:1;
 221         bool persistent:1;
 222         bool nopersistent:1;
 223         bool resilient:1; /* noresilient not required since not fored for CA */
 224         bool domainauto:1;
 225         bool rdma:1;
 226         bool multichannel:1;
 227         bool use_client_guid:1;
 228         /* reuse existing guid for multichannel */
 229         u8 client_guid[SMB2_CLIENT_GUID_SIZE];
 230         unsigned int bsize;
 231         unsigned int rsize;
 232         unsigned int wsize;
 233         unsigned int min_offload;
 234         bool sockopt_tcp_nodelay:1;
 235         unsigned long actimeo; /* attribute cache timeout (jiffies) */
 236         struct smb_version_operations *ops;
 237         struct smb_version_values *vals;
 238         char *prepath;
 239         struct sockaddr_storage dstaddr; /* destination address */
 240         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
 241         struct nls_table *local_nls; /* This is a copy of the pointer in cifs_sb */
 242         unsigned int echo_interval; /* echo interval in secs */
 243         __u64 snapshot_time; /* needed for timewarp tokens */
 244         __u32 handle_timeout; /* persistent and durable handle timeout in ms */
 245         unsigned int max_credits; /* smb3 max_credits 10 < credits < 60000 */
 246         unsigned int max_channels;
 247         __u16 compression; /* compression algorithm 0xFFFF default 0=disabled */
 248         bool rootfs:1; /* if it's a SMB root file system */
 249         bool witness:1; /* use witness protocol */
 250
 251         char *mount_options;
 252 };
 253
 254 extern const struct fs_parameter_spec smb3_fs_parameters[];
 255
 256 extern int cifs_parse_cache_flavor(char *value,
 257                                    struct smb3_fs_context *ctx);
 258 extern int cifs_parse_security_flavors(char *value,
 259                                        struct smb3_fs_context *ctx);
 260 extern int smb3_init_fs_context(struct fs_context *fc);
 261 extern void smb3_cleanup_fs_context_contents(struct smb3_fs_context *ctx);
 262 extern void smb3_cleanup_fs_context(struct smb3_fs_context *ctx);
 263
 264 static inline struct smb3_fs_context *smb3_fc2context(const struct fs_context *fc)
 265 {
 266         return fc->fs_private;
 267 }
 268
 269 extern int smb3_fs_context_dup(struct smb3_fs_context *new_ctx, struct smb3_fs_context *ctx);
 270 extern void smb3_update_mnt_flags(struct cifs_sb_info *cifs_sb);
 271
 272 #endif