fs/smb/client/smb2proto.h

   1 /* SPDX-License-Identifier: LGPL-2.1 */
   2 /*
   3  *
   4  *   Copyright (c) International Business Machines  Corp., 2002, 2011
   5  *                 Etersoft, 2012
   6  *   Author(s): Steve French ([email protected])
   7  *              Pavel Shilovsky ([email protected]) 2012
   8  *
   9  */
  10 #ifndef _SMB2PROTO_H
  11 #define _SMB2PROTO_H
  12 #include <linux/nls.h>
  13 #include <linux/key-type.h>
  14
  15 struct statfs;
  16 struct smb_rqst;
  17
  18 /*
  19  *****************************************************************
  20  * All Prototypes
  21  *****************************************************************
  22  */
  23 extern int map_smb2_to_linux_error(char *buf, bool log_err);
  24 extern int smb2_check_message(char *buf, unsigned int length,
  25                               struct TCP_Server_Info *server);
  26 extern unsigned int smb2_calc_size(void *buf);
  27 extern char *smb2_get_data_area_len(int *off, int *len,
  28                                     struct smb2_hdr *shdr);
  29 extern __le16 *cifs_convert_path_to_utf16(const char *from,
  30                                           struct cifs_sb_info *cifs_sb);
  31
  32 extern int smb2_verify_signature(struct smb_rqst *, struct TCP_Server_Info *);
  33 extern int smb2_check_receive(struct mid_q_entry *mid,
  34                               struct TCP_Server_Info *server, bool log_error);
  35 extern struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses,
  36                                               struct TCP_Server_Info *,
  37                                               struct smb_rqst *rqst);
  38 extern struct mid_q_entry *smb2_setup_async_request(
  39                         struct TCP_Server_Info *server, struct smb_rqst *rqst);
  40 extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server,
  41                                                 __u64 ses_id, __u32  tid);
  42 extern int smb2_calc_signature(struct smb_rqst *rqst,
  43                                 struct TCP_Server_Info *server,
  44                                 bool allocate_crypto);
  45 extern int smb3_calc_signature(struct smb_rqst *rqst,
  46                                 struct TCP_Server_Info *server,
  47                                 bool allocate_crypto);
  48 extern void smb2_echo_request(struct work_struct *work);
  49 extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode);
  50 extern bool smb2_is_valid_oplock_break(char *buffer,
  51                                        struct TCP_Server_Info *srv);
  52 extern int smb3_handle_read_data(struct TCP_Server_Info *server,
  53                                  struct mid_q_entry *mid);
  54 extern int smb2_query_reparse_tag(const unsigned int xid, struct cifs_tcon *tcon,
  55                                 struct cifs_sb_info *cifs_sb, const char *path,
  56                                 __u32 *reparse_tag);
  57 struct inode *smb2_get_reparse_inode(struct cifs_open_info_data *data,
  58                                      struct super_block *sb,
  59                                      const unsigned int xid,
  60                                      struct cifs_tcon *tcon,
  61                                      const char *full_path,
  62                                      bool directory,
  63                                      struct kvec *reparse_iov,
  64                                      struct kvec *xattr_iov);
  65 int smb2_query_reparse_point(const unsigned int xid,
  66                              struct cifs_tcon *tcon,
  67                              struct cifs_sb_info *cifs_sb,
  68                              const char *full_path,
  69                              u32 *tag, struct kvec *rsp,
  70                              int *rsp_buftype);
  71 int smb2_query_path_info(const unsigned int xid,
  72                          struct cifs_tcon *tcon,
  73                          struct cifs_sb_info *cifs_sb,
  74                          const char *full_path,
  75                          struct cifs_open_info_data *data);
  76 extern int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon,
  77                               const char *full_path, __u64 size,
  78                               struct cifs_sb_info *cifs_sb, bool set_alloc,
  79                                   struct dentry *dentry);
  80 extern int smb2_set_file_info(struct inode *inode, const char *full_path,
  81                               FILE_BASIC_INFO *buf, const unsigned int xid);
  82 extern int smb311_posix_mkdir(const unsigned int xid, struct inode *inode,
  83                                umode_t mode, struct cifs_tcon *tcon,
  84                                const char *full_path,
  85                                struct cifs_sb_info *cifs_sb);
  86 extern int smb2_mkdir(const unsigned int xid, struct inode *inode,
  87                       umode_t mode, struct cifs_tcon *tcon,
  88                       const char *name, struct cifs_sb_info *cifs_sb);
  89 extern void smb2_mkdir_setinfo(struct inode *inode, const char *full_path,
  90                                struct cifs_sb_info *cifs_sb,
  91                                struct cifs_tcon *tcon, const unsigned int xid);
  92 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon,
  93                       const char *name, struct cifs_sb_info *cifs_sb);
  94 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon,
  95                        const char *name, struct cifs_sb_info *cifs_sb,
  96                            struct dentry *dentry);
  97 int smb2_rename_path(const unsigned int xid,
  98                      struct cifs_tcon *tcon,
  99                      struct dentry *source_dentry,
 100                      const char *from_name, const char *to_name,
 101                      struct cifs_sb_info *cifs_sb);
 102 int smb2_create_hardlink(const unsigned int xid,
 103                          struct cifs_tcon *tcon,
 104                          struct dentry *source_dentry,
 105                          const char *from_name, const char *to_name,
 106                          struct cifs_sb_info *cifs_sb);
 107 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
 108                         struct cifs_sb_info *cifs_sb, const unsigned char *path,
 109                         char *pbuf, unsigned int *pbytes_written);
 110 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon,
 111                           struct cifs_sb_info *cifs_sb,
 112                           const unsigned char *path, char *pbuf,
 113                           unsigned int *pbytes_read);
 114 int smb2_parse_native_symlink(char **target, const char *buf, unsigned int len,
 115                               bool unicode, bool relative,
 116                               const char *full_path,
 117                               struct cifs_sb_info *cifs_sb);
 118 int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb,
 119                                 const struct kvec *iov,
 120                                 const char *full_path,
 121                                 char **path);
 122 int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock,
 123                    void *buf);
 124 extern int smb2_unlock_range(struct cifsFileInfo *cfile,
 125                              struct file_lock *flock, const unsigned int xid);
 126 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile);
 127 extern void smb2_reconnect_server(struct work_struct *work);
 128 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server);
 129 extern unsigned long smb_rqst_len(struct TCP_Server_Info *server,
 130                                   struct smb_rqst *rqst);
 131 extern void smb2_set_next_command(struct cifs_tcon *tcon,
 132                                   struct smb_rqst *rqst);
 133 extern void smb2_set_related(struct smb_rqst *rqst);
 134 extern void smb2_set_replay(struct TCP_Server_Info *server,
 135                             struct smb_rqst *rqst);
 136 extern bool smb2_should_replay(struct cifs_tcon *tcon,
 137                           int *pretries,
 138                           int *pcur_sleep);
 139
 140 /*
 141  * SMB2 Worker functions - most of protocol specific implementation details
 142  * are contained within these calls.
 143  */
 144 extern int SMB2_negotiate(const unsigned int xid,
 145                           struct cifs_ses *ses,
 146                           struct TCP_Server_Info *server);
 147 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses,
 148                            struct TCP_Server_Info *server,
 149                            const struct nls_table *nls_cp);
 150 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses);
 151 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses,
 152                      const char *tree, struct cifs_tcon *tcon,
 153                      const struct nls_table *);
 154 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon);
 155 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms,
 156                      __le16 *path, __u8 *oplock,
 157                      struct smb2_file_all_info *buf,
 158                      struct create_posix_rsp *posix,
 159                      struct kvec *err_iov, int *resp_buftype);
 160 extern int SMB2_open_init(struct cifs_tcon *tcon,
 161                           struct TCP_Server_Info *server,
 162                           struct smb_rqst *rqst,
 163                           __u8 *oplock, struct cifs_open_parms *oparms,
 164                           __le16 *path);
 165 extern void SMB2_open_free(struct smb_rqst *rqst);
 166 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon,
 167                      u64 persistent_fid, u64 volatile_fid, u32 opcode,
 168                      char *in_data, u32 indatalen, u32 maxoutlen,
 169                      char **out_data, u32 *plen /* returned data len */);
 170 extern int SMB2_ioctl_init(struct cifs_tcon *tcon,
 171                            struct TCP_Server_Info *server,
 172                            struct smb_rqst *rqst,
 173                            u64 persistent_fid, u64 volatile_fid, u32 opcode,
 174                            char *in_data, u32 indatalen,
 175                            __u32 max_response_size);
 176 extern void SMB2_ioctl_free(struct smb_rqst *rqst);
 177 extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon,
 178                         u64 persistent_fid, u64 volatile_fid, bool watch_tree,
 179                         u32 completion_filter, u32 max_out_data_len,
 180                         char **out_data, u32 *plen /* returned data len */);
 181
 182 extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
 183                         u64 persistent_fid, u64 volatile_fid,
 184                         struct smb2_file_network_open_info *pbuf);
 185 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon,
 186                       u64 persistent_file_id, u64 volatile_file_id);
 187 extern int SMB2_close_init(struct cifs_tcon *tcon,
 188                            struct TCP_Server_Info *server,
 189                            struct smb_rqst *rqst,
 190                            u64 persistent_fid, u64 volatile_fid,
 191                            bool query_attrs);
 192 extern void SMB2_close_free(struct smb_rqst *rqst);
 193 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon,
 194                       u64 persistent_file_id, u64 volatile_file_id);
 195 extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst,
 196                            struct cifs_tcon *tcon,
 197                            struct TCP_Server_Info *server,
 198                            u64 persistent_file_id, u64 volatile_file_id);
 199 extern void SMB2_flush_free(struct smb_rqst *rqst);
 200 extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon,
 201                 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen);
 202 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon,
 203                            u64 persistent_file_id, u64 volatile_file_id,
 204                            struct smb2_file_all_info *data);
 205 extern int SMB2_query_info_init(struct cifs_tcon *tcon,
 206                                 struct TCP_Server_Info *server,
 207                                 struct smb_rqst *rqst,
 208                                 u64 persistent_fid, u64 volatile_fid,
 209                                 u8 info_class, u8 info_type,
 210                                 u32 additional_info, size_t output_len,
 211                                 size_t input_len, void *input);
 212 extern void SMB2_query_info_free(struct smb_rqst *rqst);
 213 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon,
 214                           u64 persistent_file_id, u64 volatile_file_id,
 215                           void **data, unsigned int *plen, u32 info);
 216 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon,
 217                             u64 persistent_fid, u64 volatile_fid,
 218                             __le64 *uniqueid);
 219 extern int smb2_async_readv(struct cifs_io_subrequest *rdata);
 220 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms,
 221                      unsigned int *nbytes, char **buf, int *buf_type);
 222 extern void smb2_async_writev(struct cifs_io_subrequest *wdata);
 223 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms,
 224                       unsigned int *nbytes, struct kvec *iov, int n_vec);
 225 extern int SMB2_echo(struct TCP_Server_Info *server);
 226 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon,
 227                                 u64 persistent_fid, u64 volatile_fid, int index,
 228                                 struct cifs_search_info *srch_inf);
 229 extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon,
 230                                      struct TCP_Server_Info *server,
 231                                      struct smb_rqst *rqst,
 232                                      u64 persistent_fid, u64 volatile_fid,
 233                                      int index, int info_level);
 234 extern void SMB2_query_directory_free(struct smb_rqst *rqst);
 235 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon,
 236                         u64 persistent_fid, u64 volatile_fid, u32 pid,
 237                         loff_t new_eof);
 238 extern int SMB2_set_info_init(struct cifs_tcon *tcon,
 239                               struct TCP_Server_Info *server,
 240                               struct smb_rqst *rqst,
 241                               u64 persistent_fid, u64 volatile_fid, u32 pid,
 242                               u8 info_class, u8 info_type, u32 additional_info,
 243                               void **data, unsigned int *size);
 244 extern void SMB2_set_info_free(struct smb_rqst *rqst);
 245 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon,
 246                         u64 persistent_fid, u64 volatile_fid,
 247                         struct smb_ntsd *pnntsd, int pacllen, int aclflag);
 248 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon,
 249                        u64 persistent_fid, u64 volatile_fid,
 250                        struct smb2_file_full_ea_info *buf, int len);
 251 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon,
 252                                 u64 persistent_fid, u64 volatile_fid);
 253 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon,
 254                              const u64 persistent_fid, const u64 volatile_fid,
 255                              const __u8 oplock_level);
 256 extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon,
 257                                        __u64 persistent_fid,
 258                                        __u64 volatile_fid);
 259 extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server);
 260 void smb2_cancelled_close_fid(struct work_struct *work);
 261 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon,
 262                          u64 persistent_file_id, u64 volatile_file_id,
 263                          struct kstatfs *FSData);
 264 extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon,
 265                          u64 persistent_file_id, u64 volatile_file_id,
 266                          struct kstatfs *FSData);
 267 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon,
 268                          u64 persistent_file_id, u64 volatile_file_id, int lvl);
 269 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon,
 270                      const __u64 persist_fid, const __u64 volatile_fid,
 271                      const __u32 pid, const __u64 length, const __u64 offset,
 272                      const __u32 lockFlags, const bool wait);
 273 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon,
 274                       const __u64 persist_fid, const __u64 volatile_fid,
 275                       const __u32 pid, const __u32 num_lock,
 276                       struct smb2_lock_element *buf);
 277 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon,
 278                             __u8 *lease_key, const __le32 lease_state);
 279 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *);
 280
 281 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *,
 282                                         enum securityEnum);
 283 int smb2_parse_contexts(struct TCP_Server_Info *server,
 284                         struct kvec *rsp_iov,
 285                         unsigned int *epoch,
 286                         char *lease_key, __u8 *oplock,
 287                         struct smb2_file_all_info *buf,
 288                         struct create_posix_rsp *posix);
 289
 290 extern int smb3_encryption_required(const struct cifs_tcon *tcon);
 291 extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length,
 292                              struct kvec *iov, unsigned int min_buf_size);
 293 extern int smb2_validate_and_copy_iov(unsigned int offset,
 294                                       unsigned int buffer_length,
 295                                       struct kvec *iov,
 296                                       unsigned int minbufsize, char *data);
 297 extern void smb2_copy_fs_info_to_kstatfs(
 298          struct smb2_fs_full_size_info *pfs_inf,
 299          struct kstatfs *kst);
 300 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server);
 301 extern int smb311_update_preauth_hash(struct cifs_ses *ses,
 302                                       struct TCP_Server_Info *server,
 303                                       struct kvec *iov, int nvec);
 304 extern int smb2_query_info_compound(const unsigned int xid,
 305                                     struct cifs_tcon *tcon,
 306                                     const char *path, u32 desired_access,
 307                                     u32 class, u32 type, u32 output_len,
 308                                     struct kvec *rsp, int *buftype,
 309                                     struct cifs_sb_info *cifs_sb);
 310 /* query path info from the server using SMB311 POSIX extensions*/
 311 int smb311_posix_query_path_info(const unsigned int xid,
 312                                  struct cifs_tcon *tcon,
 313                                  struct cifs_sb_info *cifs_sb,
 314                                  const char *full_path,
 315                                  struct cifs_open_info_data *data);
 316 int posix_info_parse(const void *beg, const void *end,
 317                      struct smb2_posix_info_parsed *out);
 318 int posix_info_sid_size(const void *beg, const void *end);
 319 int smb2_create_reparse_symlink(const unsigned int xid, struct inode *inode,
 320                                 struct dentry *dentry, struct cifs_tcon *tcon,
 321                                 const char *full_path, const char *symname);
 322 int smb2_make_nfs_node(unsigned int xid, struct inode *inode,
 323                        struct dentry *dentry, struct cifs_tcon *tcon,
 324                        const char *full_path, umode_t mode, dev_t dev);
 325
 326 #endif                  /* _SMB2PROTO_H */