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 13 #include <linux/nls.h> 14 #include <linux/key-type.h> 15 #include "cached_dir.h" 16 17 struct smb_rqst; 18 19 /* 20 ***************************************************************** 21 * All Prototypes 22 ***************************************************************** 23 */ 24 int map_smb2_to_linux_error(char *buf, bool log_err); 25 int smb2_init_maperror(void); 26 #if IS_ENABLED(CONFIG_SMB_KUNIT_TESTS) 27 const struct status_to_posix_error *smb2_get_err_map_test(__u32 smb2_status); 28 extern const struct status_to_posix_error *smb2_error_map_table_test; 29 extern unsigned int smb2_error_map_num; 30 #endif 31 32 int smb2_check_message(char *buf, unsigned int pdu_len, unsigned int len, 33 struct TCP_Server_Info *server); 34 unsigned int smb2_calc_size(void *buf); 35 char *smb2_get_data_area_len(int *off, int *len, struct smb2_hdr *shdr); 36 __le16 *cifs_convert_path_to_utf16(const char *from, 37 struct cifs_sb_info *cifs_sb); 38 39 int smb2_verify_signature(struct smb_rqst *rqst, 40 struct TCP_Server_Info *server); 41 int smb2_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server, 42 bool log_error); 43 struct mid_q_entry *smb2_setup_request(struct cifs_ses *ses, 44 struct TCP_Server_Info *server, 45 struct smb_rqst *rqst); 46 struct mid_q_entry *smb2_setup_async_request(struct TCP_Server_Info *server, 47 struct smb_rqst *rqst); 48 struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server, 49 __u64 ses_id, __u32 tid); 50 __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode, unsigned int oplock); 51 bool smb2_is_valid_oplock_break(char *buffer, struct TCP_Server_Info *server); 52 int smb3_handle_read_data(struct TCP_Server_Info *server, 53 struct mid_q_entry *mid); 54 struct inode *smb2_create_reparse_inode(struct cifs_open_info_data *data, 55 struct super_block *sb, 56 const unsigned int xid, 57 struct cifs_tcon *tcon, 58 const char *full_path, bool directory, 59 struct kvec *reparse_iov, 60 struct kvec *xattr_iov); 61 int smb2_query_reparse_point(const unsigned int xid, struct cifs_tcon *tcon, 62 struct cifs_sb_info *cifs_sb, 63 const char *full_path, u32 *tag, struct kvec *rsp, 64 int *rsp_buftype); 65 int smb2_query_path_info(const unsigned int xid, struct cifs_tcon *tcon, 66 struct cifs_sb_info *cifs_sb, const char *full_path, 67 struct cifs_open_info_data *data); 68 int smb2_set_path_size(const unsigned int xid, struct cifs_tcon *tcon, 69 const char *full_path, __u64 size, 70 struct cifs_sb_info *cifs_sb, bool set_alloc, 71 struct dentry *dentry); 72 int smb2_set_file_info(struct inode *inode, const char *full_path, 73 FILE_BASIC_INFO *buf, const unsigned int xid); 74 int smb311_posix_mkdir(const unsigned int xid, struct inode *inode, 75 umode_t mode, struct cifs_tcon *tcon, 76 const char *full_path, struct cifs_sb_info *cifs_sb); 77 int smb2_mkdir(const unsigned int xid, struct inode *parent_inode, 78 umode_t mode, struct cifs_tcon *tcon, const char *name, 79 struct cifs_sb_info *cifs_sb); 80 void smb2_mkdir_setinfo(struct inode *inode, const char *name, 81 struct cifs_sb_info *cifs_sb, struct cifs_tcon *tcon, 82 const unsigned int xid); 83 int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon, 84 const char *name, struct cifs_sb_info *cifs_sb); 85 int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon, 86 const char *name, struct cifs_sb_info *cifs_sb, 87 struct dentry *dentry); 88 int smb2_rename_path(const unsigned int xid, struct cifs_tcon *tcon, 89 struct dentry *source_dentry, const char *from_name, 90 const char *to_name, struct cifs_sb_info *cifs_sb); 91 int smb2_create_hardlink(const unsigned int xid, struct cifs_tcon *tcon, 92 struct dentry *source_dentry, const char *from_name, 93 const char *to_name, struct cifs_sb_info *cifs_sb); 94 int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 95 struct cifs_sb_info *cifs_sb, 96 const unsigned char *path, char *pbuf, 97 unsigned int *pbytes_written); 98 int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 99 struct cifs_sb_info *cifs_sb, 100 const unsigned char *path, char *pbuf, 101 unsigned int *pbytes_read); 102 int smb2_fix_symlink_target_type(char **target, bool directory, 103 struct cifs_sb_info *cifs_sb); 104 int smb2_parse_native_symlink(char **target, const char *buf, unsigned int len, 105 bool relative, const char *full_path, 106 struct cifs_sb_info *cifs_sb); 107 int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb, 108 const struct kvec *iov, const char *full_path, 109 char **path); 110 int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms, 111 __u32 *oplock, void *buf); 112 int smb2_unlock_range(struct cifsFileInfo *cfile, struct file_lock *flock, 113 const unsigned int xid); 114 int smb2_push_mandatory_locks(struct cifsFileInfo *cfile); 115 void smb2_reconnect_server(struct work_struct *work); 116 int smb3_crypto_aead_allocate(struct TCP_Server_Info *server); 117 unsigned long smb_rqst_len(struct TCP_Server_Info *server, 118 struct smb_rqst *rqst); 119 void smb2_set_next_command(struct cifs_tcon *tcon, struct smb_rqst *rqst); 120 void smb2_set_related(struct smb_rqst *rqst); 121 void smb2_set_replay(struct TCP_Server_Info *server, struct smb_rqst *rqst); 122 bool smb2_should_replay(struct cifs_tcon *tcon, int *pretries, 123 int *pcur_sleep); 124 125 /* 126 * SMB2 Worker functions - most of protocol specific implementation details 127 * are contained within these calls. 128 */ 129 int SMB2_negotiate(const unsigned int xid, struct cifs_ses *ses, 130 struct TCP_Server_Info *server); 131 int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses, 132 struct TCP_Server_Info *server, 133 const struct nls_table *nls_cp); 134 int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses); 135 int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses, const char *tree, 136 struct cifs_tcon *tcon, const struct nls_table *cp); 137 int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon); 138 int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms, 139 __le16 *path, __u8 *oplock, struct smb2_file_all_info *buf, 140 struct create_posix_rsp *posix, struct kvec *err_iov, 141 int *buftype); 142 int SMB2_open_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server, 143 struct smb_rqst *rqst, __u8 *oplock, 144 struct cifs_open_parms *oparms, __le16 *path); 145 void SMB2_open_free(struct smb_rqst *rqst); 146 int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon, 147 u64 persistent_fid, u64 volatile_fid, u32 opcode, char *in_data, 148 u32 indatalen, u32 max_out_data_len, char **out_data, 149 u32 *plen /* returned data len */); 150 int SMB2_ioctl_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server, 151 struct smb_rqst *rqst, u64 persistent_fid, 152 u64 volatile_fid, u32 opcode, char *in_data, u32 indatalen, 153 __u32 max_response_size); 154 void SMB2_ioctl_free(struct smb_rqst *rqst); 155 int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon, 156 u64 persistent_fid, u64 volatile_fid, bool watch_tree, 157 u32 completion_filter, u32 max_out_data_len, 158 char **out_data, u32 *plen /* returned data len */); 159 160 int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 161 u64 persistent_fid, u64 volatile_fid, 162 struct smb2_file_network_open_info *pbuf); 163 int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 164 u64 persistent_fid, u64 volatile_fid); 165 int SMB2_close_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server, 166 struct smb_rqst *rqst, u64 persistent_fid, 167 u64 volatile_fid, bool query_attrs); 168 void SMB2_close_free(struct smb_rqst *rqst); 169 int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon, 170 u64 persistent_fid, u64 volatile_fid); 171 int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst, 172 struct cifs_tcon *tcon, struct TCP_Server_Info *server, 173 u64 persistent_fid, u64 volatile_fid); 174 void SMB2_flush_free(struct smb_rqst *rqst); 175 int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon, 176 u64 persistent_fid, u64 volatile_fid, 177 struct smb2_file_all_info *data); 178 int SMB2_query_info_init(struct cifs_tcon *tcon, 179 struct TCP_Server_Info *server, struct smb_rqst *rqst, 180 u64 persistent_fid, u64 volatile_fid, u8 info_class, 181 u8 info_type, u32 additional_info, size_t output_len, 182 size_t input_len, void *input); 183 void SMB2_query_info_free(struct smb_rqst *rqst); 184 int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon, 185 u64 persistent_fid, u64 volatile_fid, void **data, 186 u32 *plen, u32 extra_info); 187 int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon, 188 u64 persistent_fid, u64 volatile_fid, __le64 *uniqueid); 189 int smb2_async_readv(struct cifs_io_subrequest *rdata); 190 int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms, 191 unsigned int *nbytes, char **buf, int *buf_type); 192 void smb2_async_writev(struct cifs_io_subrequest *wdata); 193 int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms, 194 unsigned int *nbytes, struct kvec *iov, int n_vec); 195 int SMB2_echo(struct TCP_Server_Info *server); 196 int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon, 197 u64 persistent_fid, u64 volatile_fid, int index, 198 struct cifs_search_info *srch_inf); 199 int SMB2_query_directory_init(const unsigned int xid, struct cifs_tcon *tcon, 200 struct TCP_Server_Info *server, 201 struct smb_rqst *rqst, u64 persistent_fid, 202 u64 volatile_fid, int index, int info_level); 203 void SMB2_query_directory_free(struct smb_rqst *rqst); 204 int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon, 205 u64 persistent_fid, u64 volatile_fid, u32 pid, 206 loff_t new_eof); 207 int SMB2_set_info_init(struct cifs_tcon *tcon, struct TCP_Server_Info *server, 208 struct smb_rqst *rqst, u64 persistent_fid, 209 u64 volatile_fid, u32 pid, u8 info_class, u8 info_type, 210 u32 additional_info, void **data, unsigned int *size); 211 void SMB2_set_info_free(struct smb_rqst *rqst); 212 int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon, 213 u64 persistent_fid, u64 volatile_fid, struct smb_ntsd *pnntsd, 214 int pacllen, int aclflag); 215 int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon, 216 u64 persistent_fid, u64 volatile_fid, 217 struct smb2_file_full_ea_info *buf, int len); 218 int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon, 219 u64 persistent_fid, u64 volatile_fid); 220 int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon, 221 const u64 persistent_fid, const u64 volatile_fid, 222 __u8 oplock_level); 223 int smb2_handle_cancelled_close(struct cifs_tcon *tcon, __u64 persistent_fid, 224 __u64 volatile_fid); 225 int smb2_handle_cancelled_mid(struct mid_q_entry *mid, 226 struct TCP_Server_Info *server); 227 void smb2_cancelled_close_fid(struct work_struct *work); 228 int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon, 229 u64 persistent_fid, u64 volatile_fid, 230 struct kstatfs *fsdata); 231 int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon, 232 u64 persistent_fid, u64 volatile_fid, int level); 233 int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon, 234 const __u64 persist_fid, const __u64 volatile_fid, 235 const __u32 pid, const __u64 length, const __u64 offset, 236 const __u32 lock_flags, const bool wait); 237 int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon, 238 const __u64 persist_fid, const __u64 volatile_fid, 239 const __u32 pid, const __u32 num_lock, 240 struct smb2_lock_element *buf); 241 int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon, 242 __u8 *lease_key, const __le32 lease_state); 243 int smb3_validate_negotiate(const unsigned int xid, struct cifs_tcon *tcon); 244 245 enum securityEnum smb2_select_sectype(struct TCP_Server_Info *server, 246 enum securityEnum requested); 247 int smb2_parse_contexts(struct TCP_Server_Info *server, struct kvec *rsp_iov, 248 __u16 *epoch, char *lease_key, __u8 *oplock, 249 struct smb2_file_all_info *buf, 250 struct create_posix_rsp *posix); 251 252 int smb3_encryption_required(const struct cifs_tcon *tcon); 253 int smb2_validate_iov(unsigned int offset, unsigned int buffer_length, 254 struct kvec *iov, unsigned int min_buf_size); 255 int smb2_validate_and_copy_iov(unsigned int offset, unsigned int buffer_length, 256 struct kvec *iov, unsigned int minbufsize, 257 char *data); 258 void smb2_copy_fs_info_to_kstatfs(struct smb2_fs_full_size_info *pfs_inf, 259 struct kstatfs *kst); 260 void smb311_update_preauth_hash(struct cifs_ses *ses, 261 struct TCP_Server_Info *server, 262 struct kvec *iov, int nvec); 263 int smb2_query_info_compound(const unsigned int xid, struct cifs_tcon *tcon, 264 const char *path, u32 desired_access, u32 class, 265 u32 type, u32 output_len, struct kvec *rsp, 266 int *buftype, struct cifs_sb_info *cifs_sb); 267 /* query path info from the server using SMB311 POSIX extensions*/ 268 int posix_info_parse(const void *beg, const void *end, 269 struct smb2_posix_info_parsed *out); 270 int posix_info_sid_size(const void *beg, const void *end); 271 int smb2_rename_pending_delete(const char *full_path, struct dentry *dentry, 272 const unsigned int xid); 273 274 #endif /* _SMB2PROTO_H */ 275