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