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