fs/cifs/smb2proto.h

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