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