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 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_ses *smb2_find_smb_ses(struct TCP_Server_Info *server, 41 __u64 ses_id); 42 extern struct cifs_tcon *smb2_find_smb_tcon(struct TCP_Server_Info *server, 43 __u64 ses_id, __u32 tid); 44 extern int smb2_calc_signature(struct smb_rqst *rqst, 45 struct TCP_Server_Info *server, 46 bool allocate_crypto); 47 extern int smb3_calc_signature(struct smb_rqst *rqst, 48 struct TCP_Server_Info *server, 49 bool allocate_crypto); 50 extern void smb2_echo_request(struct work_struct *work); 51 extern __le32 smb2_get_lease_state(struct cifsInodeInfo *cinode); 52 extern bool smb2_is_valid_oplock_break(char *buffer, 53 struct TCP_Server_Info *srv); 54 extern int smb3_handle_read_data(struct TCP_Server_Info *server, 55 struct mid_q_entry *mid); 56 extern int smb2_query_reparse_tag(const unsigned int xid, struct cifs_tcon *tcon, 57 struct cifs_sb_info *cifs_sb, const char *path, 58 __u32 *reparse_tag); 59 struct inode *smb2_get_reparse_inode(struct cifs_open_info_data *data, 60 struct super_block *sb, 61 const unsigned int xid, 62 struct cifs_tcon *tcon, 63 const char *full_path, 64 struct kvec *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 extern int smb2_set_file_info(struct inode *inode, const char *full_path, 80 FILE_BASIC_INFO *buf, const unsigned int xid); 81 extern 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); 85 extern 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); 88 extern 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); 91 extern int smb2_rmdir(const unsigned int xid, struct cifs_tcon *tcon, 92 const char *name, struct cifs_sb_info *cifs_sb); 93 extern int smb2_unlink(const unsigned int xid, struct cifs_tcon *tcon, 94 const char *name, struct cifs_sb_info *cifs_sb); 95 int smb2_rename_path(const unsigned int xid, 96 struct cifs_tcon *tcon, 97 struct dentry *source_dentry, 98 const char *from_name, const char *to_name, 99 struct cifs_sb_info *cifs_sb); 100 int smb2_create_hardlink(const unsigned int xid, 101 struct cifs_tcon *tcon, 102 struct dentry *source_dentry, 103 const char *from_name, const char *to_name, 104 struct cifs_sb_info *cifs_sb); 105 extern int smb3_create_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 106 struct cifs_sb_info *cifs_sb, const unsigned char *path, 107 char *pbuf, unsigned int *pbytes_written); 108 extern int smb3_query_mf_symlink(unsigned int xid, struct cifs_tcon *tcon, 109 struct cifs_sb_info *cifs_sb, 110 const unsigned char *path, char *pbuf, 111 unsigned int *pbytes_read); 112 int smb2_parse_symlink_response(struct cifs_sb_info *cifs_sb, const struct kvec *iov, char **path); 113 int smb2_open_file(const unsigned int xid, struct cifs_open_parms *oparms, __u32 *oplock, 114 void *buf); 115 extern int smb2_unlock_range(struct cifsFileInfo *cfile, 116 struct file_lock *flock, const unsigned int xid); 117 extern int smb2_push_mandatory_locks(struct cifsFileInfo *cfile); 118 extern void smb2_reconnect_server(struct work_struct *work); 119 extern int smb3_crypto_aead_allocate(struct TCP_Server_Info *server); 120 extern unsigned long smb_rqst_len(struct TCP_Server_Info *server, 121 struct smb_rqst *rqst); 122 extern void smb2_set_next_command(struct cifs_tcon *tcon, 123 struct smb_rqst *rqst); 124 extern void smb2_set_related(struct smb_rqst *rqst); 125 extern void smb2_set_replay(struct TCP_Server_Info *server, 126 struct smb_rqst *rqst); 127 extern bool smb2_should_replay(struct cifs_tcon *tcon, 128 int *pretries, 129 int *pcur_sleep); 130 131 /* 132 * SMB2 Worker functions - most of protocol specific implementation details 133 * are contained within these calls. 134 */ 135 extern int SMB2_negotiate(const unsigned int xid, 136 struct cifs_ses *ses, 137 struct TCP_Server_Info *server); 138 extern int SMB2_sess_setup(const unsigned int xid, struct cifs_ses *ses, 139 struct TCP_Server_Info *server, 140 const struct nls_table *nls_cp); 141 extern int SMB2_logoff(const unsigned int xid, struct cifs_ses *ses); 142 extern int SMB2_tcon(const unsigned int xid, struct cifs_ses *ses, 143 const char *tree, struct cifs_tcon *tcon, 144 const struct nls_table *); 145 extern int SMB2_tdis(const unsigned int xid, struct cifs_tcon *tcon); 146 extern int SMB2_open(const unsigned int xid, struct cifs_open_parms *oparms, 147 __le16 *path, __u8 *oplock, 148 struct smb2_file_all_info *buf, 149 struct create_posix_rsp *posix, 150 struct kvec *err_iov, int *resp_buftype); 151 extern int SMB2_open_init(struct cifs_tcon *tcon, 152 struct TCP_Server_Info *server, 153 struct smb_rqst *rqst, 154 __u8 *oplock, struct cifs_open_parms *oparms, 155 __le16 *path); 156 extern void SMB2_open_free(struct smb_rqst *rqst); 157 extern int SMB2_ioctl(const unsigned int xid, struct cifs_tcon *tcon, 158 u64 persistent_fid, u64 volatile_fid, u32 opcode, 159 char *in_data, u32 indatalen, u32 maxoutlen, 160 char **out_data, u32 *plen /* returned data len */); 161 extern int SMB2_ioctl_init(struct cifs_tcon *tcon, 162 struct TCP_Server_Info *server, 163 struct smb_rqst *rqst, 164 u64 persistent_fid, u64 volatile_fid, u32 opcode, 165 char *in_data, u32 indatalen, 166 __u32 max_response_size); 167 extern void SMB2_ioctl_free(struct smb_rqst *rqst); 168 extern int SMB2_change_notify(const unsigned int xid, struct cifs_tcon *tcon, 169 u64 persistent_fid, u64 volatile_fid, bool watch_tree, 170 u32 completion_filter, u32 max_out_data_len, 171 char **out_data, u32 *plen /* returned data len */); 172 173 extern int __SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 174 u64 persistent_fid, u64 volatile_fid, 175 struct smb2_file_network_open_info *pbuf); 176 extern int SMB2_close(const unsigned int xid, struct cifs_tcon *tcon, 177 u64 persistent_file_id, u64 volatile_file_id); 178 extern int SMB2_close_init(struct cifs_tcon *tcon, 179 struct TCP_Server_Info *server, 180 struct smb_rqst *rqst, 181 u64 persistent_fid, u64 volatile_fid, 182 bool query_attrs); 183 extern void SMB2_close_free(struct smb_rqst *rqst); 184 extern int SMB2_flush(const unsigned int xid, struct cifs_tcon *tcon, 185 u64 persistent_file_id, u64 volatile_file_id); 186 extern int SMB2_flush_init(const unsigned int xid, struct smb_rqst *rqst, 187 struct cifs_tcon *tcon, 188 struct TCP_Server_Info *server, 189 u64 persistent_file_id, u64 volatile_file_id); 190 extern void SMB2_flush_free(struct smb_rqst *rqst); 191 extern int SMB311_posix_query_info(const unsigned int xid, struct cifs_tcon *tcon, 192 u64 persistent_fid, u64 volatile_fid, struct smb311_posix_qinfo *data, u32 *plen); 193 extern int SMB2_query_info(const unsigned int xid, struct cifs_tcon *tcon, 194 u64 persistent_file_id, u64 volatile_file_id, 195 struct smb2_file_all_info *data); 196 extern int SMB2_query_info_init(struct cifs_tcon *tcon, 197 struct TCP_Server_Info *server, 198 struct smb_rqst *rqst, 199 u64 persistent_fid, u64 volatile_fid, 200 u8 info_class, u8 info_type, 201 u32 additional_info, size_t output_len, 202 size_t input_len, void *input); 203 extern void SMB2_query_info_free(struct smb_rqst *rqst); 204 extern int SMB2_query_acl(const unsigned int xid, struct cifs_tcon *tcon, 205 u64 persistent_file_id, u64 volatile_file_id, 206 void **data, unsigned int *plen, u32 info); 207 extern int SMB2_get_srv_num(const unsigned int xid, struct cifs_tcon *tcon, 208 u64 persistent_fid, u64 volatile_fid, 209 __le64 *uniqueid); 210 extern int smb2_async_readv(struct cifs_readdata *rdata); 211 extern int SMB2_read(const unsigned int xid, struct cifs_io_parms *io_parms, 212 unsigned int *nbytes, char **buf, int *buf_type); 213 extern int smb2_async_writev(struct cifs_writedata *wdata, 214 void (*release)(struct kref *kref)); 215 extern int SMB2_write(const unsigned int xid, struct cifs_io_parms *io_parms, 216 unsigned int *nbytes, struct kvec *iov, int n_vec); 217 extern int SMB2_echo(struct TCP_Server_Info *server); 218 extern int SMB2_query_directory(const unsigned int xid, struct cifs_tcon *tcon, 219 u64 persistent_fid, u64 volatile_fid, int index, 220 struct cifs_search_info *srch_inf); 221 extern int SMB2_query_directory_init(unsigned int xid, struct cifs_tcon *tcon, 222 struct TCP_Server_Info *server, 223 struct smb_rqst *rqst, 224 u64 persistent_fid, u64 volatile_fid, 225 int index, int info_level); 226 extern void SMB2_query_directory_free(struct smb_rqst *rqst); 227 extern int SMB2_set_eof(const unsigned int xid, struct cifs_tcon *tcon, 228 u64 persistent_fid, u64 volatile_fid, u32 pid, 229 loff_t new_eof); 230 extern int SMB2_set_info_init(struct cifs_tcon *tcon, 231 struct TCP_Server_Info *server, 232 struct smb_rqst *rqst, 233 u64 persistent_fid, u64 volatile_fid, u32 pid, 234 u8 info_class, u8 info_type, u32 additional_info, 235 void **data, unsigned int *size); 236 extern void SMB2_set_info_free(struct smb_rqst *rqst); 237 extern int SMB2_set_acl(const unsigned int xid, struct cifs_tcon *tcon, 238 u64 persistent_fid, u64 volatile_fid, 239 struct cifs_ntsd *pnntsd, int pacllen, int aclflag); 240 extern int SMB2_set_ea(const unsigned int xid, struct cifs_tcon *tcon, 241 u64 persistent_fid, u64 volatile_fid, 242 struct smb2_file_full_ea_info *buf, int len); 243 extern int SMB2_set_compression(const unsigned int xid, struct cifs_tcon *tcon, 244 u64 persistent_fid, u64 volatile_fid); 245 extern int SMB2_oplock_break(const unsigned int xid, struct cifs_tcon *tcon, 246 const u64 persistent_fid, const u64 volatile_fid, 247 const __u8 oplock_level); 248 extern int smb2_handle_cancelled_close(struct cifs_tcon *tcon, 249 __u64 persistent_fid, 250 __u64 volatile_fid); 251 extern int smb2_handle_cancelled_mid(struct mid_q_entry *mid, struct TCP_Server_Info *server); 252 void smb2_cancelled_close_fid(struct work_struct *work); 253 extern int SMB2_QFS_info(const unsigned int xid, struct cifs_tcon *tcon, 254 u64 persistent_file_id, u64 volatile_file_id, 255 struct kstatfs *FSData); 256 extern int SMB311_posix_qfs_info(const unsigned int xid, struct cifs_tcon *tcon, 257 u64 persistent_file_id, u64 volatile_file_id, 258 struct kstatfs *FSData); 259 extern int SMB2_QFS_attr(const unsigned int xid, struct cifs_tcon *tcon, 260 u64 persistent_file_id, u64 volatile_file_id, int lvl); 261 extern int SMB2_lock(const unsigned int xid, struct cifs_tcon *tcon, 262 const __u64 persist_fid, const __u64 volatile_fid, 263 const __u32 pid, const __u64 length, const __u64 offset, 264 const __u32 lockFlags, const bool wait); 265 extern int smb2_lockv(const unsigned int xid, struct cifs_tcon *tcon, 266 const __u64 persist_fid, const __u64 volatile_fid, 267 const __u32 pid, const __u32 num_lock, 268 struct smb2_lock_element *buf); 269 extern int SMB2_lease_break(const unsigned int xid, struct cifs_tcon *tcon, 270 __u8 *lease_key, const __le32 lease_state); 271 extern int smb3_validate_negotiate(const unsigned int, struct cifs_tcon *); 272 273 extern enum securityEnum smb2_select_sectype(struct TCP_Server_Info *, 274 enum securityEnum); 275 int smb2_parse_contexts(struct TCP_Server_Info *server, 276 struct kvec *rsp_iov, 277 unsigned int *epoch, 278 char *lease_key, __u8 *oplock, 279 struct smb2_file_all_info *buf, 280 struct create_posix_rsp *posix); 281 282 extern int smb3_encryption_required(const struct cifs_tcon *tcon); 283 extern int smb2_validate_iov(unsigned int offset, unsigned int buffer_length, 284 struct kvec *iov, unsigned int min_buf_size); 285 extern int smb2_validate_and_copy_iov(unsigned int offset, 286 unsigned int buffer_length, 287 struct kvec *iov, 288 unsigned int minbufsize, char *data); 289 extern void smb2_copy_fs_info_to_kstatfs( 290 struct smb2_fs_full_size_info *pfs_inf, 291 struct kstatfs *kst); 292 extern int smb311_crypto_shash_allocate(struct TCP_Server_Info *server); 293 extern int smb311_update_preauth_hash(struct cifs_ses *ses, 294 struct TCP_Server_Info *server, 295 struct kvec *iov, int nvec); 296 extern int smb2_query_info_compound(const unsigned int xid, 297 struct cifs_tcon *tcon, 298 const char *path, u32 desired_access, 299 u32 class, u32 type, u32 output_len, 300 struct kvec *rsp, int *buftype, 301 struct cifs_sb_info *cifs_sb); 302 /* query path info from the server using SMB311 POSIX extensions*/ 303 int smb311_posix_query_path_info(const unsigned int xid, 304 struct cifs_tcon *tcon, 305 struct cifs_sb_info *cifs_sb, 306 const char *full_path, 307 struct cifs_open_info_data *data); 308 int posix_info_parse(const void *beg, const void *end, 309 struct smb2_posix_info_parsed *out); 310 int posix_info_sid_size(const void *beg, const void *end); 311 312 #endif /* _SMB2PROTO_H */ 313